@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.1

package/script/src/types/info/orders.d.ts

@@ -1,266 +0,0 @@
-import type { Hex } from "../mod.js";
-/** L2 order book snapshot. */
-export interface Book {
-    /** Asset symbol. */
-    coin: string;
-    /** Timestamp of the snapshot (in ms since epoch). */
-    time: number;
-    /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-    levels: [BookLevel[], BookLevel[]];
-}
-/** Order book level. */
-export interface BookLevel {
-    /**
-     * Price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    px: string;
-    /**
-     * Total size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Number of individual orders. */
-    n: number;
-}
-/** Trade fill record. */
-export interface Fill {
-    /** Asset symbol. */
-    coin: string;
-    /**
-     * Price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    px: string;
-    /**
-     * Size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-    side: "B" | "A";
-    /** Timestamp when the trade occurred (in ms since epoch). */
-    time: number;
-    /**
-     * Start position size.
-     * @pattern ^-?[0-9]+(\.[0-9]+)?$
-     */
-    startPosition: string;
-    /** Direction indicator for frontend display. */
-    dir: string;
-    /**
-     * Realized PnL.
-     * @pattern ^-?[0-9]+(\.[0-9]+)?$
-     */
-    closedPnl: string;
-    /** L1 transaction hash. */
-    hash: Hex;
-    /** Order ID. */
-    oid: number;
-    /** Indicates if the fill was a taker order. */
-    crossed: boolean;
-    /**
-     * Fee charged or rebate received (negative indicates rebate).
-     * @pattern ^-?[0-9]+(\.[0-9]+)?$
-     */
-    fee: string;
-    /** Unique transaction identifier for a partial fill of an order. */
-    tid: number;
-    /** Client Order ID. */
-    cloid?: Hex;
-    /** Liquidation details. */
-    liquidation?: FillLiquidation;
-    /** Token in which the fee is denominated (e.g., "USDC"). */
-    feeToken: string;
-    /** ID of the TWAP. */
-    twapId: number | null;
-}
-/** Liquidation details for a trade fill. */
-export interface FillLiquidation {
-    /** Address of the liquidated user. */
-    liquidatedUser: Hex;
-    /**
-     * Mark price at the time of liquidation.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    markPx: string;
-    /** Liquidation method. */
-    method: "market" | "backstop";
-}
-/** Open order with additional display information. */
-export interface FrontendOrder extends Omit<Order, "reduceOnly" | "cloid"> {
-    /** Condition for triggering the order. */
-    triggerCondition: string;
-    /** Indicates if the order is a trigger order. */
-    isTrigger: boolean;
-    /**
-     * Trigger price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    triggerPx: string;
-    /** Child orders associated with this order. */
-    children: FrontendOrder[];
-    /** Indicates if the order is a position TP/SL order. */
-    isPositionTpsl: boolean;
-    /** Indicates whether the order is reduce-only. */
-    reduceOnly: boolean;
-    /** Order type. */
-    orderType: OrderType;
-    /** Time-in-force option. */
-    tif: TIF | null;
-    /** Client Order ID. */
-    cloid: Hex | null;
-}
-/** Open order details. */
-export interface Order {
-    /** Asset symbol. */
-    coin: string;
-    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-    side: "B" | "A";
-    /**
-     * Limit price.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    limitPx: string;
-    /**
-     * Size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Order ID. */
-    oid: number;
-    /** Timestamp when the order was placed (in ms since epoch). */
-    timestamp: number;
-    /**
-     * Original size at order placement.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    origSz: string;
-    /** Client Order ID. */
-    cloid?: Hex;
-    /** Indicates if the order is reduce-only. */
-    reduceOnly?: true;
-}
-/** Result of an order status lookup. */
-export type OrderLookup = {
-    /** Indicates that the order was found. */
-    status: "order";
-    /** Order details. */
-    order: OrderStatus<FrontendOrder>;
-} | {
-    /** Indicates that the order was not found. */
-    status: "unknownOid";
-};
-/**
- * Order processing status.
- * - `open`: Order active and waiting to be filled.
- * - `filled`: Order fully executed.
- * - `canceled`: Order canceled by the user.
- * - `triggered`: Order triggered and awaiting execution.
- * - `rejected`: Order rejected by the system.
- * - `marginCanceled`: Order canceled due to insufficient margin.
- * - `vaultWithdrawalCanceled`: Canceled due to a user withdrawal from vault.
- * - `openInterestCapCanceled`: Canceled due to order being too aggressive when open interest was at cap.
- * - `selfTradeCanceled`: Canceled due to self-trade prevention.
- * - `reduceOnlyCanceled`: Canceled reduced-only order that does not reduce position.
- * - `siblingFilledCanceled`: Canceled due to sibling ordering being filled.
- * - `delistedCanceled`: Canceled due to asset delisting.
- * - `liquidatedCanceled`: Canceled due to liquidation.
- * - `scheduledCancel`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
- */
-export type OrderProcessingStatus = "open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "reduceOnlyRejected";
-/** Order with current processing status. */
-export interface OrderStatus<O extends Order | FrontendOrder> {
-    /** Order details. */
-    order: O;
-    /** Order processing status. */
-    status: OrderProcessingStatus;
-    /** Timestamp when the status was last updated (in ms since epoch). */
-    statusTimestamp: number;
-}
-/**
- * Order types for market execution.
- * - `Market`: Executes immediately at the market price.
- * - `Limit`: Executes at the specified limit price or better.
- * - `Stop Market`: Activates as a market order when a stop price is reached.
- * - `Stop Limit`: Activates as a limit order when a stop price is reached.
- * - `Take Profit Market`: Executes as a market order when a take profit price is reached.
- * - `Take Profit Limit`: Executes as a limit order when a take profit price is reached.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
- */
-export type OrderType = "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
-/**
- * Time-in-force options.
- * - `Gtc`: Remains active until filled or canceled.
- * - `Ioc`: Fills immediately or cancels any unfilled portion.
- * - `Alo`: Adds liquidity only.
- * - `FrontendMarket`: Similar to Ioc, used in Hyperliquid UI.
- * - `LiquidationMarket`: Similar to Ioc, used in Hyperliquid UI.
- */
-export type TIF = "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
-/** TWAP history record for a user. */
-export interface TwapHistory {
-    /** Creation time of the history record (in seconds since epoch). */
-    time: number;
-    /** State of the TWAP order. */
-    state: TwapState;
-    /** Current status of the TWAP order. */
-    status: TwapStatus;
-}
-/** TWAP slice fill details. */
-export interface TwapSliceFill {
-    /** Fill details for the TWAP slice. */
-    fill: Omit<Fill, "cloid" | "liquidation">;
-    /** ID of the TWAP. */
-    twapId: number;
-}
-/** Current state of a TWAP order. */
-export interface TwapState {
-    /** Asset symbol. */
-    coin: string;
-    /**
-     * Executed notional value.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    executedNtl: string;
-    /**
-     * Executed size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    executedSz: string;
-    /** Duration in minutes. */
-    minutes: number;
-    /** Indicates if the TWAP randomizes execution. */
-    randomize: boolean;
-    /** Indicates if the order is reduce-only. */
-    reduceOnly: boolean;
-    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-    side: "B" | "A";
-    /**
-     * Order size.
-     * @pattern ^[0-9]+(\.[0-9]+)?$
-     */
-    sz: string;
-    /** Start time of the TWAP order (in ms since epoch). */
-    timestamp: number;
-    /** User address. */
-    user: Hex;
-}
-/**
- * TWAP order status.
- * - `finished`: Fully executed.
- * - `activated`: Active and executing.
- * - `terminated`: Terminated.
- * - `error`: An error occurred.
- */
-export type TwapStatus = {
-    /** Status of the TWAP order. */
-    status: "finished" | "activated" | "terminated";
-} | {
-    /** Status of the TWAP order. */
-    status: "error";
-    /** Error message. */
-    description: string;
-};
-//# sourceMappingURL=orders.d.ts.map

package/script/src/types/info/orders.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,8BAA8B;AAC9B,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;CACtC;AAED,wBAAwB;AACxB,MAAM,WAAW,SAAS;IACtB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,yBAAyB;AACzB,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,IAAI,EAAE,GAAG,CAAC;IACV,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,2BAA2B;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC5B,sCAAsC;IACtC,cAAc,EAAE,GAAG,CAAC;IACpB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;CACjC;AAED,sDAAsD;AACtD,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;IACtE,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,wDAAwD;IACxD,cAAc,EAAE,OAAO,CAAC;IACxB,kDAAkD;IAClD,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,4BAA4B;IAC5B,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChB,uBAAuB;IACvB,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,KAAK;IAClB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,6CAA6C;IAC7C,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,wCAAwC;AACxC,MAAM,MAAM,WAAW,GACjB;IACE,0CAA0C;IAC1C,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACrC,GACC;IACE,8CAA8C;IAC9C,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAEN;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,qBAAqB,GAC3B,MAAM,GACN,QAAQ,GACR,UAAU,GACV,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,yBAAyB,GACzB,yBAAyB,GACzB,mBAAmB,GACnB,oBAAoB,GACpB,uBAAuB,GACvB,kBAAkB,GAClB,oBAAoB,GACpB,iBAAiB,GACjB,oBAAoB,CAAC;AAE3B,4CAA4C;AAC5C,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,aAAa;IACxD,qBAAqB;IACrB,KAAK,EAAE,CAAC,CAAC;IACT,+BAA+B;IAC/B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,SAAS,GACf,QAAQ,GACR,OAAO,GACP,aAAa,GACb,YAAY,GACZ,oBAAoB,GACpB,mBAAmB,CAAC;AAE1B;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAEjF,sCAAsC;AACtC,MAAM,WAAW,WAAW;IACxB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,MAAM,EAAE,UAAU,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,aAAa;IAC1B,uCAAuC;IACvC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAAC,CAAC;IAC1C,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAChB;IACE,gCAAgC;IAChC,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;CACnD,GACC;IACE,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC"}

package/script/src/types/info/orders.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });