@syldel/hl-shared-types 0.0.8 → 0.0.10

package/dist/interfaces/common/common.interfaces.d.ts

@@ -2,3 +2,10 @@ export type DecimalString = string;
 export type Timestamp = number;
 export type HexString = `0x${string}`;
 export type HLOid = number | HexString;
+/**
+ * Time In Force options for Hyperliquid orders.
+ * Gtc: Good Til Cancelled
+ * Ioc: Immediate Or Cancel
+ * Alo: Add Liquidity Only (Post-Only)
+ */
+export type HLTif = 'Gtc' | 'Ioc' | 'Alo';

package/dist/interfaces/orders/open-order.interfaces.d.ts

@@ -1,20 +1,44 @@
-import { DecimalString, HLOid, Timestamp } from '../common';
+import { DecimalString, HLOid, HLTif, Timestamp } from '../common';
+/**
+ * Base response for any order info returned by the API.
+ * These fields are common to all order-related info endpoints.
+ */
 export interface HLOpenOrder {
+    /** Asset symbol (e.g., "BTC", "@107") */
     coin: string;
+    /** Limit price as a string */
     limitPx: DecimalString;
+    /** Internal Hyperliquid Order ID */
     oid: HLOid;
+    /** 'A' for Ask (Sell), 'B' for Bid (Buy) */
     side: 'A' | 'B';
+    /** Current size of the order */
     sz: DecimalString;
+    /** Transaction timestamp in milliseconds */
     timestamp: Timestamp;
 }
 export type HLOpenOrdersResponse = HLOpenOrder[];
+/**
+ * Enhanced order details for frontend-specific views.
+ */
 export interface HLFrontendOpenOrder extends HLOpenOrder {
+    /** True if this is a Take Profit or Stop Loss for an open position */
     isPositionTpsl: boolean;
+    /** True if this is a trigger order (Stop/TP) */
     isTrigger: boolean;
-    orderType: 'Limit' | 'Market';
+    /** Descriptive order type (e.g., "Limit", "Stop Market") */
+    orderType: string;
+    /** Original size of the order when placed */
     origSz: DecimalString;
+    /** True if the order can only reduce position size */
     reduceOnly: boolean;
+    /** Human-readable trigger condition (e.g., "Price >= 30000" or "N/A") */
     triggerCondition: string;
+    /** Price that triggers the order, if applicable */
     triggerPx: DecimalString;
+    /** Time In Force: API can return specific labels like "FrontendMarket" */
+    tif?: HLTif | string | null;
+    /** Client Order ID: always present in response, but can be null */
+    cloid?: string | null;
 }
 export type HLFrontendOpenOrdersResponse = HLFrontendOpenOrder[];

package/dist/interfaces/orders/order-details.interfaces.d.ts

@@ -1,4 +1,4 @@
-import { DecimalString } from '../common';
+import { DecimalString, HLTif } from '../common';
 /**
  * Détails d'un ordre à placer sur Hyperliquid.
  *
@@ -33,7 +33,7 @@ export interface HLOrderDetails {
     reduceOnly: boolean;
     orderType: {
         limit: {
-            tif: 'Alo' | 'Ioc' | 'Gtc';
+            tif: HLTif;
         };
     } | {
         trigger: {
@@ -56,7 +56,7 @@ export interface HLApiOrder {
     r: boolean;
     t: {
         limit: {
-            tif: 'Alo' | 'Ioc' | 'Gtc';
+            tif: HLTif;
         };
     } | {
         trigger: {

package/dist/interfaces/orders/order-status.interfaces.d.ts

@@ -1,22 +1,8 @@
-import { DecimalString, HLOid, Timestamp } from '../common';
+import { HLOid, Timestamp } from '../common';
+import { HLFrontendOpenOrder } from './open-order.interfaces';
 export type HLOrderStatus = 'open' | 'filled' | 'canceled' | 'triggered' | 'rejected' | 'marginCanceled' | 'vaultWithdrawalCanceled' | 'openInterestCapCanceled' | 'selfTradeCanceled' | 'reduceOnlyCanceled' | 'siblingFilledCanceled' | 'delistedCanceled' | 'liquidatedCanceled' | 'scheduledCancel' | 'tickRejected' | 'minTradeNtlRejected' | 'perpMarginRejected' | 'reduceOnlyRejected' | 'badAloPxRejected' | 'iocCancelRejected' | 'badTriggerPxRejected' | 'marketOrderNoLiquidityRejected' | 'positionIncreaseAtOpenInterestCapRejected' | 'positionFlipAtOpenInterestCapRejected' | 'tooAggressiveAtOpenInterestCapRejected' | 'openInterestIncreaseRejected' | 'insufficientSpotBalanceRejected' | 'oracleRejected' | 'perpMaxPositionRejected';
-export interface HLOrderStatusDetails {
-    coin: string;
-    side: 'A' | 'B';
-    limitPx: DecimalString;
-    sz: DecimalString;
-    oid: HLOid;
-    timestamp: Timestamp;
-    triggerCondition: string;
-    isTrigger: boolean;
-    triggerPx: DecimalString;
+export interface HLOrderStatusDetails extends HLFrontendOpenOrder {
     children: unknown[];
-    isPositionTpsl: boolean;
-    reduceOnly: boolean;
-    orderType: string;
-    origSz: DecimalString;
-    tif: string;
-    cloid: string | null;
 }
 export interface HLOrderStatusData {
     order: HLOrderStatusDetails;

package/dist/interfaces/perp/dexs.interfaces.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Represents the request body for the Hyperliquid info endpoint.
+ */
+export interface HLInfoRequest {
+    /** The type of information to retrieve. For perpetual DEXs, use 'perpDexs'. */
+    type: 'perpDexs';
+}
+/**
+ * Represents a Perpetual DEX entry on the Hyperliquid exchange.
+ */
+export interface HLPerpDex {
+    /** The unique short name/identifier of the DEX. */
+    name: string;
+    /** The full descriptive name of the DEX. */
+    fullName: string;
+    /** The Ethereum address of the account that deployed the DEX. */
+    deployer: string;
+    /** The address authorized to update oracles, or null if not set. */
+    oracleUpdater: string | null;
+    /** The address designated to receive trading fees, or null if not set. */
+    feeRecipient: string | null;
+    /** * A collection of streaming Open Interest caps per asset.
+     * Represented as an array of tuples: [Asset Name, Cap Value].
+     */
+    assetToStreamingOiCap: [string, string][];
+    /** * A collection of funding rate multipliers per asset.
+     * Represented as an array of tuples: [Asset Name, Multiplier].
+     */
+    assetToFundingMultiplier: [string, string][];
+}
+/**
+ * The raw response format from the Hyperliquid API for the 'perpDexs' type.
+ * The API typically returns an array where the first element can be null.
+ */
+export type HLPerpDexsResponse = (HLPerpDex | null)[];

package/dist/interfaces/perp/dexs.interfaces.js

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

package/dist/interfaces/perp/index.d.ts

@@ -1,2 +1,3 @@
 export * from './balance.interfaces';
 export * from './meta.interfaces';
+export * from './dexs.interfaces';

package/dist/interfaces/perp/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./balance.interfaces"), exports);
 __exportStar(require("./meta.interfaces"), exports);
+__exportStar(require("./dexs.interfaces"), exports);

package/dist/interfaces/spot/balance.interfaces.d.ts

@@ -1,11 +1,23 @@
 import { DecimalString } from '../common';
+/**
+ * User's balance for a spot asset.
+ */
 export interface HLSpotBalance {
+    /** Asset symbol, e.g. "USDC" or "ETH". */
     coin: string;
+    /** Token index in Hyperliquid's system. */
     token: number;
+    /** Amount currently on hold / reserved. */
     hold: DecimalString;
+    /** Total amount owned (available + hold). */
     total: DecimalString;
+    /** Entry notional for the position. */
     entryNtl: DecimalString;
 }
+/**
+ * Spot clearinghouse state containing all balances.
+ */
 export interface HLSpotClearinghouseState {
+    /** Array of spot balances for this user. */
     balances: HLSpotBalance[];
 }

package/dist/interfaces/spot/meta.interfaces.d.ts

@@ -1,23 +1,50 @@
+/**
+ * Metadata for a spot token.
+ */
 export interface HLSpotTokenMeta {
+    /** Token symbol, e.g. "USDC". */
     name: string;
+    /** Number of decimals for display purposes. */
     szDecimals: number;
+    /** Number of decimals used on-chain (wei). */
     weiDecimals: number;
+    /** Token index in Hyperliquid system. */
     index: number;
+    /** Unique token identifier. */
     tokenId: string;
+    /** Whether this is the canonical token in the system. */
     isCanonical: boolean;
+    /** EVM contract address (if applicable). */
     evmContract: string | null;
+    /** Full token name, optional. */
     fullName: string | null;
 }
+/**
+ * Metadata for a spot market.
+ */
 export interface HLSpotMarketMeta {
+    /** Market symbol, e.g. "ETH/USDC". */
     name: string;
+    /** Indexes of the base and quote tokens. */
     tokens: [number, number];
+    /** Market index in Hyperliquid system. */
     index: number;
+    /** Whether the market uses canonical tokens. */
     isCanonical: boolean;
 }
+/**
+ * Complete spot metadata including tokens and markets.
+ */
 export interface HLSpotMeta {
+    /** All spot tokens. */
     tokens: HLSpotTokenMeta[];
+    /** All spot markets (universe). */
     universe: HLSpotMarketMeta[];
 }
+/**
+ * Summary of a spot asset, extending market metadata.
+ */
 export interface HLSpotAssetSummary extends HLSpotMarketMeta {
+    /** Optional: number of decimals for size/amount display. */
     szDecimals?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syldel/hl-shared-types",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "Shared TypeScript interfaces and types for Hyperliquid integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",