@lifi/perps-sdk-provider-hyperliquid 6.0.0 → 6.0.2

package/dist/types/services/getActivity.d.ts

@@ -10,11 +10,15 @@ import type { HyperliquidContext } from '../context.js';
  */
 export interface GetActivityParams {
     address: Address;
+    /** Maximum items returned; defaults to 50 and is capped at 200. */
     limit?: number;
-    /** `cursor` is a ms-since-epoch upper bound — items with `timestamp < cursor` are returned. */
+    /** Millisecond timestamp cursor; rows strictly older than it are returned. */
     cursor?: string;
+    /** Inclusive lower bound in milliseconds since epoch; defaults to 90 days ago. */
     startTime?: number;
+    /** Inclusive upper bound in milliseconds since epoch. */
     endTime?: number;
+    /** Optional normalized activity-type filter applied after mapping. */
     type?: ActivityType[];
 }
 /**

package/dist/types/services/getActivity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getActivity.d.ts","sourceRoot":"","sources":["../../../src/services/getActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EACV,kBAAkB,EAGnB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAOnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAYvD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+FAA+F;IAC/F,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,YAAY,EAAE,CAAA;CACtB;AAmDD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,GACtB,oBAAoB,kBAAkB,EACtC,QAAQ,iBAAiB,EACzB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,kBAAkB,CAuD5B,CAAA"}
+{"version":3,"file":"getActivity.d.ts","sourceRoot":"","sources":["../../../src/services/getActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EACV,kBAAkB,EAGnB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAOnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAYvD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sEAAsE;IACtE,IAAI,CAAC,EAAE,YAAY,EAAE,CAAA;CACtB;AAmDD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,GACtB,oBAAoB,kBAAkB,EACtC,QAAQ,iBAAiB,EACzB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,kBAAkB,CAuD5B,CAAA"}

package/dist/types/services/getFills.d.ts

@@ -9,12 +9,13 @@ import type { HyperliquidContext } from '../context.js';
  */
 export interface GetFillsParams {
     address: Address;
+    /** Maximum items returned; defaults to 50 and is capped at 200. */
     limit?: number;
-    /** Opaque pagination cursor from a previous page's `pagination.cursor`. */
+    /** Opaque cursor returned in the previous page's `pagination.cursor`. */
     cursor?: string;
-    /** Inclusive lower bound in ms-since-epoch — switches to the `userFillsByTime` endpoint. */
+    /** Inclusive lower bound in milliseconds; selects `userFillsByTime`. */
     startTime?: number;
-    /** Inclusive upper bound in ms-since-epoch — switches to the `userFillsByTime` endpoint. */
+    /** Inclusive upper bound in milliseconds; selects `userFillsByTime`. */
     endTime?: number;
 }
 /**

package/dist/types/services/getFills.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFills.d.ts","sourceRoot":"","sources":["../../../src/services/getFills.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAMnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AASvD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAoBD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GACnB,oBAAoB,kBAAkB,EACtC,QAAQ,cAAc,EACtB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,aAAa,CAqDvB,CAAA"}
+{"version":3,"file":"getFills.d.ts","sourceRoot":"","sources":["../../../src/services/getFills.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAMnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AASvD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAoBD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GACnB,oBAAoB,kBAAkB,EACtC,QAAQ,cAAc,EACtB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,aAAa,CAqDvB,CAAA"}

package/dist/types/services/getOrders.d.ts

@@ -9,8 +9,9 @@ import type { HyperliquidContext } from '../context.js';
  */
 export interface GetOrdersParams {
     address: Address;
-    /** Optional filter — opaque `Market.id`. */
+    /** Optional filter using the normalized opaque `Market.id`. */
     marketId?: string;
+    /** Page-size hint; Hyperliquid returns all open orders in one response. */
     limit?: number;
 }
 /**

package/dist/types/services/getOrders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getOrders.d.ts","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EAAa,cAAc,EAAgB,MAAM,mBAAmB,CAAA;AAChF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAavD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GACpB,oBAAoB,kBAAkB,EACtC,QAAQ,eAAe,EACvB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,cAAc,CAyDxB,CAAA"}
+{"version":3,"file":"getOrders.d.ts","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EAAa,cAAc,EAAgB,MAAM,mBAAmB,CAAA;AAChF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAavD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GACpB,oBAAoB,kBAAkB,EACtC,QAAQ,eAAe,EACvB,UAAU,iBAAiB,KAC1B,OAAO,CAAC,cAAc,CAyDxB,CAAA"}

package/dist/types/services/getPositions.d.ts

@@ -9,9 +9,9 @@ import type { HyperliquidContext } from '../context.js';
  */
 export interface GetPositionsParams {
     address: Address;
-    /** Filter to a single opaque `Market.id` (e.g. `'BTC'`, `'xyz:PURR'`). */
+    /** Optional filter using the normalized opaque `Market.id`. */
     marketId?: string;
-    /** Page size hint surfaced on the response. Hyperliquid returns all open positions in one call, so pagination is never required. */
+    /** Page-size hint; Hyperliquid returns all open positions in one response. */
     limit?: number;
 }
 /**

package/dist/types/services/getPositions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getPositions.d.ts","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AASvD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oIAAoI;IACpI,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GACvB,oBAAoB,kBAAkB,EACtC,QAAQ,kBAAkB,EAC1B,UAAU,iBAAiB,KAC1B,OAAO,CAAC,iBAAiB,CA0C3B,CAAA"}
+{"version":3,"file":"getPositions.d.ts","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AASvD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GACvB,oBAAoB,kBAAkB,EACtC,QAAQ,kBAAkB,EAC1B,UAAU,iBAAiB,KAC1B,OAAO,CAAC,iBAAiB,CA0C3B,CAAA"}

package/dist/types/signers/HyperliquidAgentStore.d.ts

@@ -3,12 +3,11 @@ import { type Address, type Hex } from 'viem';
 /**
  * Hyperliquid agent keypair — an EVM keypair the user approves (via
  * `APPROVE_AGENT`) to sign trading actions on their behalf, so each order
- * does not require a wallet prompt.
+ * does not require a wallet prompt. `privateKey` is a 32-byte EVM hex key.
+ * @public
  */
 export interface HyperliquidAgent {
-    /** Agent wallet address. */
     address: Address;
-    /** Agent private key. */
     privateKey: Hex;
 }
 /**
@@ -23,6 +22,7 @@ export interface HyperliquidAgent {
  * fully compromised page — a same-origin script can still drive this store to
  * decrypt. Blast radius is limited to agent trading: fund withdrawal still
  * requires L1 `APPROVE_AGENT` consent that the agent key alone cannot grant.
+ * @public
  */
 export declare class HyperliquidAgentStore {
     private storage;

package/dist/types/signers/HyperliquidAgentStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HyperliquidAgentStore.d.ts","sourceRoot":"","sources":["../../../src/signers/HyperliquidAgentStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,iBAAiB,CAAA;AAExB,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,GAAG,EAAoB,MAAM,MAAM,CAAA;AAM/D;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4BAA4B;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,yBAAyB;IACzB,UAAU,EAAE,GAAG,CAAA;CAChB;AA0BD;;;;;;;;;;;;GAYG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,KAAK,CAA2C;gBAE5C,OAAO,CAAC,EAAE,cAAc;IAIpC,OAAO,CAAC,UAAU;IAIlB;;;;;;;OAOG;IACG,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0BtD;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0B9D,oDAAoD;IAC9C,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7C;;;OAGG;IACG,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;OAGG;IACG,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAe1E,mEAAmE;IACnE,UAAU,IAAI,IAAI;CAGnB"}
+{"version":3,"file":"HyperliquidAgentStore.d.ts","sourceRoot":"","sources":["../../../src/signers/HyperliquidAgentStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,iBAAiB,CAAA;AAExB,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,GAAG,EAAoB,MAAM,MAAM,CAAA;AAM/D;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,GAAG,CAAA;CAChB;AA0BD;;;;;;;;;;;;;GAaG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,KAAK,CAA2C;gBAE5C,OAAO,CAAC,EAAE,cAAc;IAIpC,OAAO,CAAC,UAAU;IAIlB;;;;;;;OAOG;IACG,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0BtD;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0B9D,oDAAoD;IAC9C,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7C;;;OAGG;IACG,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;OAGG;IACG,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAe1E,mEAAmE;IACnE,UAAU,IAAI,IAAI;CAGnB"}

package/dist/types/signers/signActions.d.ts

@@ -4,12 +4,14 @@ import { SigningMethod } from '@lifi/perps-types';
 import type { Address } from 'viem';
 import type { HyperliquidAgentStore } from './HyperliquidAgentStore.js';
 /**
- * Sign a batch of EIP-712 action steps. Hyperliquid owns both EIP712 arms and
- * picks WHO signs from the descriptor's `signers` (forwarded on the context):
- *   - `AGENT` → the user's Hyperliquid agent keypair (provisioned + approved
- *     during setup; a missing agent throws).
- *   - `USER` → the end-user's wallet, read from `ctx.userWallet`.
- * Hyperliquid declares no WASM_BLOB / EVM_TX actions, so those schemes reject.
+ * Sign a batch of Hyperliquid EIP-712 action steps. `AGENT` descriptors use
+ * the persisted per-user agent keypair; `USER` descriptors use
+ * `ctx.userWallet`. Other signing methods are rejected because Hyperliquid
+ * declares no WASM_BLOB or EVM_TX action schemes.
+ *
+ * @throws {PerpsError} When the method is unsupported, the required agent is
+ * missing, or a user-signed action has no wallet.
+ * @public
  */
 export declare function hyperliquidSignActions(agentStore: HyperliquidAgentStore, method: SigningMethod, steps: ActionStep[], address: Address, ctx: SignActionsContext | undefined): Promise<SignedActionStep[]>;
 //# sourceMappingURL=signActions.d.ts.map

package/dist/types/signers/signActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signActions.d.ts","sourceRoot":"","sources":["../../../src/signers/signActions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,kBAAkB,EAGxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EACV,UAAU,EAGV,gBAAgB,EACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAA+B,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAO,MAAM,MAAM,CAAA;AACxC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAEvE;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,qBAAqB,EACjC,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,UAAU,EAAE,EACnB,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,kBAAkB,GAAG,SAAS,GAClC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAsB7B"}
+{"version":3,"file":"signActions.d.ts","sourceRoot":"","sources":["../../../src/signers/signActions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,kBAAkB,EAGxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EACV,UAAU,EAGV,gBAAgB,EACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAA+B,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAO,MAAM,MAAM,CAAA;AACxC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAEvE;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,qBAAqB,EACjC,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,UAAU,EAAE,EACnB,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,kBAAkB,GAAG,SAAS,GAClC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAsB7B"}

package/dist/types/types/account.d.ts

@@ -1,22 +1,48 @@
-/** @public */
+/**
+ * Perpetual position payload from Hyperliquid `clearinghouseState`.
+ *
+ * Numeric values are decimal strings in quote-asset units except `szi`,
+ * which is signed size: positive for long and negative for short. `coin` is
+ * the Hyperliquid wire market identifier; `leverage.type` is typically
+ * `'cross'` or `'isolated'`.
+ * @public
+ */
 export type HlPosition = {
+    /** Hyperliquid wire market identifier. */
     coin: string;
+    /** Signed position size; positive is long and negative is short. */
     szi: string;
+    /** Average entry price as a decimal string. */
     entryPx: string;
+    /** Position notional value as a decimal string. */
     positionValue: string;
+    /** Estimated liquidation price; may be an empty string when unavailable. */
     liquidationPx: string;
+    /** Unrealized PnL in quote-asset units. */
     unrealizedPnl: string;
+    /** Margin currently assigned to this position. */
     marginUsed: string;
+    /** Leverage mode and numeric leverage multiplier. */
     leverage: {
         type: string;
         value: number;
     };
 };
-/** @public */
+/**
+ * Wrapper for a position in the `assetPositions` array of a clearinghouse
+ * state response.
+ * @public
+ */
 export type HlAssetPosition = {
     position: HlPosition;
 };
-/** @public */
+/**
+ * Perpetual clearinghouse account state returned by Hyperliquid `/info`.
+ * `assetPositions` includes zero-size rows that callers may discard. Monetary
+ * fields are decimal strings in the account's quote asset; `marginSummary`
+ * covers all positions while `crossMarginSummary` covers cross margin only.
+ * @public
+ */
 export type HlClearinghouseState = {
     assetPositions: HlAssetPosition[];
     marginSummary: {
@@ -28,7 +54,12 @@ export type HlClearinghouseState = {
         totalMarginUsed: string;
     };
 };
-/** @public */
+/**
+ * One spot balance from Hyperliquid `spotClearinghouseState`.
+ * `token` is the numeric spot token index, and amounts are decimal strings in
+ * the token's native units.
+ * @public
+ */
 export type HlSpotBalance = {
     coin: string;
     token: number;
@@ -36,17 +67,29 @@ export type HlSpotBalance = {
     hold: string;
     entryNtl: string;
 };
-/** @public */
+/**
+ * Spot clearinghouse state returned by Hyperliquid `/info`.
+ * @public
+ */
 export type HlSpotClearinghouseState = {
     balances: HlSpotBalance[];
 };
-/** @public */
+/**
+ * User fee rates returned by Hyperliquid `userFees`.
+ * Rates are decimal fractions represented as strings, not percentage values
+ * (for example, `'0.00045'` is 0.045%).
+ * @public
+ */
 export type HlUserFees = {
     userAddRate: string;
     userCrossRate: string;
     activeReferralDiscount: string;
 };
-/** @public */
+/**
+ * Entries returned by Hyperliquid `extraAgents`. The endpoint may add fields
+ * over time, so the provider retains each entry as an open record.
+ * @public
+ */
 export type HlExtraAgents = Record<string, unknown>[];
 /**
  * Response of the `preTransferCheck` info query. `userExists` is `false` until
@@ -87,6 +130,6 @@ export declare const HlAbstractionMode: {
     readonly PORTFOLIO_MARGIN: "portfolioMargin";
     readonly DEX_ABSTRACTION: "dexAbstraction";
 };
-/** @public */
+/** Union of the exact `userAbstraction` wire values accepted by Hyperliquid. @public */
 export type HlAbstractionMode = (typeof HlAbstractionMode)[keyof typeof HlAbstractionMode];
 //# sourceMappingURL=account.d.ts.map

package/dist/types/types/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,cAAc;AACd,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,UAAU,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,eAAe,EAAE,CAAA;IACjC,aAAa,EAAE;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,kBAAkB,EAAE;QAClB,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;CACF,CAAA;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;AAErD;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE;QAAE,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvD,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,gBAAgB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAA;AAEV,cAAc;AACd,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAA"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAA;IACX,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,aAAa,EAAE,MAAM,CAAA;IACrB,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAA;IACrB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAA;IAClB,qDAAqD;IACrD,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,UAAU,CAAA;CACrB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,eAAe,EAAE,CAAA;IACjC,aAAa,EAAE;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,kBAAkB,EAAE;QAClB,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,EAAE,MAAM,CAAA;KACxB,CAAA;CACF,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;AAErD;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE;QAAE,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvD,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,gBAAgB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAA;AAEV,wFAAwF;AACxF,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAA"}

package/dist/types/types/action.d.ts

@@ -1,4 +1,11 @@
-/** @public */
+/**
+ * EIP-712 `/exchange` request sent to Hyperliquid.
+ *
+ * `action` is the provider-specific action object; signature fields are the
+ * hex `r`/`s` values and recovery byte `v`; `nonce` is milliseconds since the
+ * Unix epoch. `vaultAddress` is included only when submitting for a vault.
+ * @public
+ */
 export type HlExchangeRequest = {
     action: Record<string, unknown>;
     signature: {
@@ -9,7 +16,14 @@ export type HlExchangeRequest = {
     nonce: number;
     vaultAddress?: string | null;
 };
-/** @public */
+/**
+ * Response envelope returned by Hyperliquid `/exchange`.
+ *
+ * A successful response may contain per-order statuses such as `filled`,
+ * `resting`, or `error`; the provider keeps the upstream status strings and
+ * numeric order IDs unchanged.
+ * @public
+ */
 export type HlExchangeResponse = {
     status: string;
     response?: string | {
@@ -42,20 +56,24 @@ export type HlExchangeResponse = {
         };
     };
 };
-/** @public */
+/** EIP-712 primary type for user approval of a Hyperliquid agent wallet. @public */
 export declare const HL_PRIMARY_TYPE_APPROVE_AGENT: "HyperliquidTransaction:ApproveAgent";
-/** @public */
+/** EIP-712 primary type for user approval of an integrator builder fee. @public */
 export declare const HL_PRIMARY_TYPE_APPROVE_BUILDER_FEE: "HyperliquidTransaction:ApproveBuilderFee";
-/** @public */
+/** EIP-712 primary type for changing the user's account abstraction mode. @public */
 export declare const HL_PRIMARY_TYPE_USER_SET_ABSTRACTION: "HyperliquidTransaction:UserSetAbstraction";
-/** @public */
+/** EIP-712 primary type for an agent wallet changing abstraction mode. @public */
 export declare const HL_PRIMARY_TYPE_AGENT_SET_ABSTRACTION: "HyperliquidTransaction:AgentSetAbstraction";
-/** @public */
+/** EIP-712 primary type for withdrawing assets from Hyperliquid. @public */
 export declare const HL_PRIMARY_TYPE_WITHDRAW: "HyperliquidTransaction:Withdraw";
-/** @public */
+/** EIP-712 primary type for sending assets between Hyperliquid accounts or DEXes. @public */
 export declare const HL_PRIMARY_TYPE_SEND_ASSET: "HyperliquidTransaction:SendAsset";
-/** @public */
+/** EIP-712 primary type used by the agent wallet authorization payload. @public */
 export declare const HL_PRIMARY_TYPE_AGENT: "Agent";
-/** @public */
+/**
+ * Union of EIP-712 primary type names supported by Hyperliquid signing actions.
+ * Values are the exact strings required in the typed-data domain.
+ * @public
+ */
 export type HlPrimaryType = typeof HL_PRIMARY_TYPE_APPROVE_AGENT | typeof HL_PRIMARY_TYPE_APPROVE_BUILDER_FEE | typeof HL_PRIMARY_TYPE_USER_SET_ABSTRACTION | typeof HL_PRIMARY_TYPE_AGENT_SET_ABSTRACTION | typeof HL_PRIMARY_TYPE_WITHDRAW | typeof HL_PRIMARY_TYPE_SEND_ASSET | typeof HL_PRIMARY_TYPE_AGENT;
 //# sourceMappingURL=action.d.ts.map

package/dist/types/types/action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../src/types/action.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,SAAS,EAAE;QACT,CAAC,EAAE,MAAM,CAAA;QACT,CAAC,EAAE,MAAM,CAAA;QACT,CAAC,EAAE,MAAM,CAAA;KACV,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EACL,MAAM,GACN;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE;YACL,QAAQ,CAAC,EAAE,CACP,MAAM,GACN;gBAAE,MAAM,EAAE;oBAAE,OAAO,EAAE,MAAM,CAAC;oBAAC,KAAK,EAAE,MAAM,CAAC;oBAAC,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GAC3D;gBAAE,OAAO,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GAC5B;gBAAE,cAAc,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GACnC;gBAAE,iBAAiB,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GACtC;gBAAE,OAAO,EAAE,IAAI,CAAA;aAAE,GACjB;gBAAE,KAAK,EAAE,MAAM,CAAA;aAAE,CACpB,EAAE,CAAA;YACH,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAA;KACF,CAAA;CACN,CAAA;AAED,cAAc;AACd,eAAO,MAAM,6BAA6B,EACxC,qCAA8C,CAAA;AAChD,cAAc;AACd,eAAO,MAAM,mCAAmC,EAC9C,0CAAmD,CAAA;AACrD,cAAc;AACd,eAAO,MAAM,oCAAoC,EAC/C,2CAAoD,CAAA;AACtD,cAAc;AACd,eAAO,MAAM,qCAAqC,EAChD,4CAAqD,CAAA;AACvD,cAAc;AACd,eAAO,MAAM,wBAAwB,EACnC,iCAA0C,CAAA;AAC5C,cAAc;AACd,eAAO,MAAM,0BAA0B,EACrC,kCAA2C,CAAA;AAC7C,cAAc;AACd,eAAO,MAAM,qBAAqB,EAAG,OAAgB,CAAA;AAErD,cAAc;AACd,MAAM,MAAM,aAAa,GACrB,OAAO,6BAA6B,GACpC,OAAO,mCAAmC,GAC1C,OAAO,oCAAoC,GAC3C,OAAO,qCAAqC,GAC5C,OAAO,wBAAwB,GAC/B,OAAO,0BAA0B,GACjC,OAAO,qBAAqB,CAAA"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../src/types/action.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,SAAS,EAAE;QACT,CAAC,EAAE,MAAM,CAAA;QACT,CAAC,EAAE,MAAM,CAAA;QACT,CAAC,EAAE,MAAM,CAAA;KACV,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EACL,MAAM,GACN;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE;YACL,QAAQ,CAAC,EAAE,CACP,MAAM,GACN;gBAAE,MAAM,EAAE;oBAAE,OAAO,EAAE,MAAM,CAAC;oBAAC,KAAK,EAAE,MAAM,CAAC;oBAAC,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GAC3D;gBAAE,OAAO,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GAC5B;gBAAE,cAAc,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GACnC;gBAAE,iBAAiB,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAA;iBAAE,CAAA;aAAE,GACtC;gBAAE,OAAO,EAAE,IAAI,CAAA;aAAE,GACjB;gBAAE,KAAK,EAAE,MAAM,CAAA;aAAE,CACpB,EAAE,CAAA;YACH,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAA;KACF,CAAA;CACN,CAAA;AAED,oFAAoF;AACpF,eAAO,MAAM,6BAA6B,EACxC,qCAA8C,CAAA;AAChD,mFAAmF;AACnF,eAAO,MAAM,mCAAmC,EAC9C,0CAAmD,CAAA;AACrD,qFAAqF;AACrF,eAAO,MAAM,oCAAoC,EAC/C,2CAAoD,CAAA;AACtD,kFAAkF;AAClF,eAAO,MAAM,qCAAqC,EAChD,4CAAqD,CAAA;AACvD,4EAA4E;AAC5E,eAAO,MAAM,wBAAwB,EACnC,iCAA0C,CAAA;AAC5C,6FAA6F;AAC7F,eAAO,MAAM,0BAA0B,EACrC,kCAA2C,CAAA;AAC7C,mFAAmF;AACnF,eAAO,MAAM,qBAAqB,EAAG,OAAgB,CAAA;AAErD;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,OAAO,6BAA6B,GACpC,OAAO,mCAAmC,GAC1C,OAAO,oCAAoC,GAC3C,OAAO,qCAAqC,GAC5C,OAAO,wBAAwB,GAC/B,OAAO,0BAA0B,GACjC,OAAO,qBAAqB,CAAA"}

package/dist/types/types/asset.d.ts

@@ -1,4 +1,8 @@
-/** @public */
+/**
+ * Perpetual market metadata from Hyperliquid `meta.universe`.
+ * `szDecimals` is the lot-size precision; `maxLeverage` is the venue cap.
+ * @public
+ */
 export type HlUniverseItem = {
     name: string;
     szDecimals: number;
@@ -8,11 +12,19 @@ export type HlUniverseItem = {
     marginMode?: 'strictIsolated' | 'noCross';
     isDelisted?: boolean;
 };
-/** @public */
+/**
+ * Perpetual metadata envelope returned by the Hyperliquid `meta` info query.
+ * @public
+ */
 export type HlMeta = {
     universe: HlUniverseItem[];
 };
-/** @public */
+/**
+ * Live perpetual market context from Hyperliquid `metaAndAssetCtxs`.
+ * Prices, funding, open interest, and volume are decimal strings; `funding`
+ * is a rate and `dayNtlVlm` is 24-hour notional volume.
+ * @public
+ */
 export type HlAssetCtx = {
     funding: string;
     openInterest: string;
@@ -20,11 +32,19 @@ export type HlAssetCtx = {
     prevDayPx: string;
     markPx: string;
 };
-/** @public */
+/**
+ * Tuple returned by `metaAndAssetCtxs`: static universe metadata followed by
+ * one live context per universe entry.
+ * @public
+ */
 export type HlMetaAndAssetCtxs = [HlMeta, HlAssetCtx[]];
-/** @public */
+/** Alias for the perpetual universe array in {@link HlMeta}. @public */
 export type HlUniverse = HlMeta['universe'];
-/** @public */
+/**
+ * OHLCV candle from Hyperliquid's candle feed. `t` is the opening timestamp
+ * in milliseconds; prices and volume are decimal strings.
+ * @public
+ */
 export type HlCandle = {
     t: number;
     o: string;
@@ -33,43 +53,68 @@ export type HlCandle = {
     c: string;
     v: string;
 };
-/** @public */
+/** Snapshot array of {@link HlCandle} values, ordered by the upstream feed. @public */
 export type HlCandleSnapshot = HlCandle[];
-/** @public */
+/**
+ * One L2 order-book level. `px` is price, `sz` is aggregate size, and `n` is
+ * the number of orders at that price; numeric values are wire strings except
+ * for the order count.
+ * @public
+ */
 export type HlLevel = {
     px: string;
     sz: string;
     n: number;
 };
-/** @public */
+/**
+ * L2 order-book snapshot with bid levels at index 0 and ask levels at index 1.
+ * `time` is the snapshot timestamp in milliseconds.
+ * @public
+ */
 export type HlL2Book = {
     levels: [HlLevel[], HlLevel[]];
     time: number;
 };
-/** @public */
+/**
+ * Perpetual DEX descriptors from Hyperliquid `perpDexs`; `null` represents the
+ * main DEX and named entries represent HIP-3 sub-DEXes.
+ * @public
+ */
 export type HlPerpDexs = (null | {
     name: string;
 })[];
-/** @public */
+/**
+ * Spot token metadata. `index` is the numeric token index used by spot
+ * clearinghouse balances; `tokenId` is the venue's wire identifier.
+ * @public
+ */
 export type HlSpotToken = {
     name: string;
     index: number;
     tokenId: string;
     szDecimals: number;
 };
-/** @public */
+/**
+ * Spot universe entry describing a trading pair. `tokens` contains the two
+ * numeric token indexes used by the pair.
+ * @public
+ */
 export type HlSpotUniverseEntry = {
     name: string;
     tokens: [number, number];
     index: number;
     isCanonical: boolean;
 };
-/** @public */
+/** Spot metadata envelope containing token definitions and trading pairs. @public */
 export type HlSpotMeta = {
     tokens: HlSpotToken[];
     universe: HlSpotUniverseEntry[];
 };
-/** @public */
+/**
+ * Live spot token context. Prices and 24-hour volume are decimal strings;
+ * `midPx` is `null` when the venue has no midpoint for the pair.
+ * @public
+ */
 export type HlSpotAssetCtx = {
     coin: string;
     prevDayPx: string;
@@ -77,6 +122,6 @@ export type HlSpotAssetCtx = {
     markPx: string;
     midPx: string | null;
 };
-/** @public */
+/** Tuple returned by the spot metadata/context info query. @public */
 export type HlSpotMetaAndAssetCtxs = [HlSpotMeta, HlSpotAssetCtx[]];
 //# sourceMappingURL=asset.d.ts.map

package/dist/types/types/asset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../../src/types/asset.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,yDAAyD;IACzD,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC3B,CAAA;AAED,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,cAAc;AACd,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;AAEvD,cAAc;AACd,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;AAE3C,cAAc;AACd,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,cAAc;AACd,MAAM,MAAM,gBAAgB,GAAG,QAAQ,EAAE,CAAA;AAEzC,cAAc;AACd,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,cAAc;AACd,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,cAAc;AACd,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,EAAE,CAAA;AAEpD,cAAc;AACd,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,QAAQ,EAAE,mBAAmB,EAAE,CAAA;CAChC,CAAA;AAED,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,sBAAsB,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA"}
+{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../../src/types/asset.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,yDAAyD;IACzD,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC3B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;AAEvD,wEAAwE;AACxE,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;AAE3C;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,uFAAuF;AACvF,MAAM,MAAM,gBAAgB,GAAG,QAAQ,EAAE,CAAA;AAEzC;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,EAAE,CAAA;AAEpD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,QAAQ,EAAE,mBAAmB,EAAE,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACrB,CAAA;AAED,sEAAsE;AACtE,MAAM,MAAM,sBAAsB,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA"}

package/dist/types/types/fill.d.ts

@@ -1,4 +1,10 @@
-/** @public */
+/**
+ * One user trade fill returned by Hyperliquid `userFills` or
+ * `userFillsByTime`. Prices, size, fee, PnL, and starting position are decimal
+ * strings; `time` is milliseconds since the Unix epoch and `tid`/`oid` are
+ * numeric trade and order IDs.
+ * @public
+ */
 export type HlUserFill = {
     tid: number;
     oid: number;
@@ -14,8 +20,8 @@ export type HlUserFill = {
     time: number;
     startPosition: string;
 };
-/** @public */
+/** All fills returned by the unbounded `userFills` query. @public */
 export type HlUserFills = HlUserFill[];
-/** @public */
+/** Fills returned by the time-bounded `userFillsByTime` query. @public */
 export type HlUserFillsByTime = HlUserFill[];
 //# sourceMappingURL=fill.d.ts.map

package/dist/types/types/fill.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fill.d.ts","sourceRoot":"","sources":["../../../src/types/fill.ts"],"names":[],"mappings":"AAEA,cAAc;AACd,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,WAAW,GAAG,UAAU,EAAE,CAAA;AAEtC,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG,UAAU,EAAE,CAAA"}
+{"version":3,"file":"fill.d.ts","sourceRoot":"","sources":["../../../src/types/fill.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,UAAU,EAAE,CAAA;AAEtC,0EAA0E;AAC1E,MAAM,MAAM,iBAAiB,GAAG,UAAU,EAAE,CAAA"}

package/dist/types/types/ledger.d.ts

@@ -45,7 +45,11 @@ export type HlSendAssetDelta = {
     nonce: number;
     feeToken: string;
 };
-/** @public */
+/**
+ * Union of known Hyperliquid non-funding ledger deltas plus an open fallback
+ * for endpoint variants the provider does not map.
+ * @public
+ */
 export type HlLedgerDelta = HlSpotTransferDelta | HlSendAssetDelta | {
     type: string;
     usdc?: string;
@@ -66,15 +70,24 @@ export declare const isSpotTransferDelta: (delta: HlLedgerDelta) => delta is HlS
  * @public
  */
 export declare const isSendAssetDelta: (delta: HlLedgerDelta) => delta is HlSendAssetDelta;
-/** @public */
+/**
+ * One timestamped non-funding ledger update. `time` is milliseconds since
+ * epoch and `hash` is the upstream transaction identifier.
+ * @public
+ */
 export type HlLedgerUpdate = {
     time: number;
     hash: string;
     delta: HlLedgerDelta;
 };
-/** @public */
+/** Array returned by `userNonFundingLedgerUpdates`. @public */
 export type HlUserNonFundingLedgerUpdates = HlLedgerUpdate[];
-/** @public */
+/**
+ * Funding ledger delta returned by Hyperliquid `userFunding`. `usdc` is the
+ * funding payment, `szi` is signed position size, and `fundingRate` is a
+ * decimal fraction; all are decimal strings.
+ * @public
+ */
 export type HlFundingDelta = {
     type: 'funding';
     coin: string;
@@ -82,12 +95,17 @@ export type HlFundingDelta = {
     szi: string;
     fundingRate: string;
 };
-/** @public */
+/**
+ * Timestamped funding update. `time` is milliseconds since epoch; `hash` is
+ * always the zero hash — funding is a system ledger event with no venue
+ * transaction behind it.
+ * @public
+ */
 export type HlFundingUpdate = {
     time: number;
     hash: string;
     delta: HlFundingDelta;
 };
-/** @public */
+/** Array returned by the `userFunding` info query. @public */
 export type HlUserFunding = HlFundingUpdate[];
 //# sourceMappingURL=ledger.d.ts.map

package/dist/types/types/ledger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ledger.d.ts","sourceRoot":"","sources":["../../../src/types/ledger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAInC;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GACrB,mBAAmB,GACnB,gBAAgB,GAChB;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAEL;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,aAAa,KACnB,KAAK,IAAI,mBAAoD,CAAA;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,aAAa,KACnB,KAAK,IAAI,gBAAyC,CAAA;AAErD,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,aAAa,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,6BAA6B,GAAG,cAAc,EAAE,CAAA;AAE5D,cAAc;AACd,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,eAAe,EAAE,CAAA"}
+{"version":3,"file":"ledger.d.ts","sourceRoot":"","sources":["../../../src/types/ledger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAInC;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,mBAAmB,GACnB,gBAAgB,GAChB;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAEL;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,aAAa,KACnB,KAAK,IAAI,mBAAoD,CAAA;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,aAAa,KACnB,KAAK,IAAI,gBAAyC,CAAA;AAErD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,aAAa,CAAA;CACrB,CAAA;AAED,+DAA+D;AAC/D,MAAM,MAAM,6BAA6B,GAAG,cAAc,EAAE,CAAA;AAE5D;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA;AAED,8DAA8D;AAC9D,MAAM,MAAM,aAAa,GAAG,eAAe,EAAE,CAAA"}

package/dist/types/types/order.d.ts

@@ -1,4 +1,9 @@
-/** @public */
+/**
+ * Open order payload returned by Hyperliquid `frontendOpenOrders`.
+ * Sizes/prices are decimal strings; timestamps are milliseconds. Trigger
+ * flags and optional `children` describe attached TP/SL orders.
+ * @public
+ */
 export type HlFrontendOpenOrder = {
     oid: number;
     coin: string;
@@ -17,9 +22,14 @@ export type HlFrontendOpenOrder = {
     tif: string | null;
     cloid: string | null;
 };
-/** @public */
+/** Array returned by the `frontendOpenOrders` info query. @public */
 export type HlFrontendOpenOrders = HlFrontendOpenOrder[];
-/** @public */
+/**
+ * Order detail nested in an `orderStatus` response. `statusTimestamp` is the
+ * last status-change time in milliseconds; `triggerPx` is nullable for orders
+ * without a trigger.
+ * @public
+ */
 export type HlOrderDetail = {
     order: {
         oid: number;
@@ -39,12 +49,16 @@ export type HlOrderDetail = {
     status: string;
     statusTimestamp: number;
 };
-/** @public */
+/** Successful `orderStatus` response containing the requested order. @public */
 export type HlOrderStatusFound = {
     status: 'order';
     order: HlOrderDetail;
 };
-/** @public */
+/**
+ * Result of `orderStatus`: either a found order or the exact `'unknownOid'`
+ * sentinel when Hyperliquid has no record for the numeric order ID.
+ * @public
+ */
 export type HlOrderStatusResponse = HlOrderStatusFound | {
     status: 'unknownOid';
 };