@syldel/hl-shared-types 0.0.1 → 0.0.4

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

@@ -0,0 +1,42 @@
+import { DecimalString, Timestamp } from '../common';
+export interface HLPerpLeverage {
+    rawUsd: DecimalString;
+    type: 'isolated' | 'cross';
+    value: number;
+}
+export interface HLPerpCumFunding {
+    allTime: DecimalString;
+    sinceChange: DecimalString;
+    sinceOpen: DecimalString;
+}
+export interface HLPerpPositionDetail {
+    coin: string;
+    cumFunding: HLPerpCumFunding;
+    entryPx: DecimalString;
+    leverage: HLPerpLeverage;
+    liquidationPx: DecimalString;
+    marginUsed: DecimalString;
+    maxLeverage: number;
+    positionValue: DecimalString;
+    returnOnEquity: DecimalString;
+    szi: DecimalString;
+    unrealizedPnl: DecimalString;
+}
+export interface HLPerpAssetPosition {
+    position: HLPerpPositionDetail | null;
+    type: 'oneWay' | 'hedged';
+}
+export interface HLPerpMarginSummary {
+    accountValue: DecimalString;
+    totalMarginUsed: DecimalString;
+    totalNtlPos: DecimalString;
+    totalRawUsd: DecimalString;
+}
+export interface HLClearinghouseState {
+    assetPositions: HLPerpAssetPosition[];
+    crossMaintenanceMarginUsed: DecimalString;
+    crossMarginSummary: HLPerpMarginSummary;
+    marginSummary: HLPerpMarginSummary;
+    time: Timestamp;
+    withdrawable: DecimalString;
+}

package/dist/interfaces/perp/balance.interfaces.js

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

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

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

package/dist/interfaces/perp/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./balance.interfaces"), exports);
+__exportStar(require("./meta.interfaces"), exports);

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

@@ -0,0 +1,50 @@
+import { DecimalString } from '../common';
+export interface HLPerpMarketInfo {
+    name: string;
+    szDecimals: number;
+    maxLeverage: number;
+    onlyIsolated?: boolean;
+    isDelisted?: boolean;
+    marginMode?: 'strictIsolated' | 'noCross';
+}
+export interface HLPerpMarginTier {
+    lowerBound: string;
+    maxLeverage: number;
+}
+export interface HLPerpMarginTable {
+    description: string;
+    marginTiers: HLPerpMarginTier[];
+}
+export type HLPerpMarginTableEntry = [number, HLPerpMarginTable];
+export interface HLPerpMeta {
+    universe: HLPerpMarketInfo[];
+    marginTables: HLPerpMarginTableEntry[];
+}
+export interface HLPerpMarketUniverse extends HLPerpMarketInfo {
+    index: number;
+}
+export interface HLPerpAssetCtx {
+    dayNtlVlm: string;
+    funding: string;
+    impactPxs: string[];
+    markPx: string;
+    midPx: string;
+    openInterest: string;
+    oraclePx: string;
+    premium: string;
+    prevDayPx: string;
+}
+export type HLPerpMetaAndCtx = [{
+    universe: HLPerpMarketInfo[];
+}, HLPerpAssetCtx[]];
+export interface HLPerpMarket {
+    index: number;
+    name: string;
+    szDecimals: number;
+    maxLeverage: number;
+    marginTableId?: number;
+    markPrice?: DecimalString;
+    midPrice?: DecimalString;
+    funding?: DecimalString;
+    openInterest?: DecimalString;
+}

package/dist/interfaces/perp/meta.interfaces.js

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

package/dist/interfaces/responses/cancel.interfaces.d.ts

@@ -0,0 +1,9 @@
+export type HLCancelStatus = 'success' | {
+    error: string;
+};
+export interface HLCancelOrderResponse {
+    type: 'cancel';
+    data: {
+        statuses: HLCancelStatus[];
+    };
+}

package/dist/interfaces/responses/cancel.interfaces.js

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

package/dist/interfaces/responses/error.interfaces.d.ts

@@ -0,0 +1,10 @@
+export interface HLErrorResponse {
+    status: 'error';
+    message: string;
+}
+/**
+ * Type guard pour vérifier si un objet est une HLErrorResponse.
+ * @param obj Objet à vérifier.
+ * @returns True si l'objet correspond à HLErrorResponse.
+ */
+export declare function isHLErrorResponse(obj: unknown): obj is HLErrorResponse;

package/dist/interfaces/responses/error.interfaces.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHLErrorResponse = isHLErrorResponse;
+/**
+ * Type guard pour vérifier si un objet est une HLErrorResponse.
+ * @param obj Objet à vérifier.
+ * @returns True si l'objet correspond à HLErrorResponse.
+ */
+function isHLErrorResponse(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        return false;
+    }
+    const errorObj = obj;
+    return ('status' in errorObj &&
+        errorObj.status === 'error' &&
+        'message' in errorObj &&
+        typeof errorObj.message === 'string');
+}

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

@@ -0,0 +1,4 @@
+export * from './error.interfaces';
+export * from './success.interfaces';
+export * from './order.interfaces';
+export * from './cancel.interfaces';

package/dist/interfaces/responses/index.js

@@ -0,0 +1,20 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.interfaces"), exports);
+__exportStar(require("./success.interfaces"), exports);
+__exportStar(require("./order.interfaces"), exports);
+__exportStar(require("./cancel.interfaces"), exports);

package/dist/interfaces/responses/order.interfaces.d.ts

@@ -0,0 +1,18 @@
+import { DecimalString, HLOid } from '../common';
+export interface HLPlaceOrderStatus {
+    resting?: {
+        oid: HLOid;
+    };
+    filled?: {
+        oid: HLOid;
+        totalSz: DecimalString;
+        avgPx: DecimalString;
+    };
+    error?: string;
+}
+export interface HLPlaceOrderResponse {
+    type: 'order';
+    data: {
+        statuses: HLPlaceOrderStatus[];
+    };
+}

package/dist/interfaces/responses/order.interfaces.js

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

package/dist/interfaces/responses/success.interfaces.d.ts

@@ -0,0 +1,4 @@
+export interface HLSuccessResponse<T = any> {
+    status: 'ok';
+    response: T;
+}

package/dist/interfaces/responses/success.interfaces.js

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

package/dist/interfaces/smart/batch-protective-order.interfaces.d.ts

@@ -0,0 +1,31 @@
+import { DecimalString, HLOid } from '../common';
+import { HLOrderDetails } from '../orders';
+import { HLProtectiveKind } from './protective-order.interfaces';
+export interface BatchProtectiveOrderItem {
+    sz: string;
+    price: string;
+    isMarket?: boolean;
+}
+export interface BatchProtectiveOrders {
+    assetName: string;
+    isBuy: boolean;
+    tp?: BatchProtectiveOrderItem[];
+    sl?: BatchProtectiveOrderItem[];
+}
+export interface ExistingProtectiveOrder {
+    oid: HLOid;
+    kind: HLProtectiveKind;
+    price: DecimalString;
+    sz: DecimalString;
+    isMarket: boolean;
+}
+export interface NormalizedProtectiveOrder {
+    kind: HLProtectiveKind;
+    price: DecimalString;
+    sz: DecimalString;
+    isMarket?: boolean;
+}
+export interface HLModifyInput {
+    oid: HLOid;
+    order: HLOrderDetails;
+}

package/dist/interfaces/smart/batch-protective-order.interfaces.js

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

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

@@ -0,0 +1,3 @@
+export * from './smart-order.interfaces';
+export * from './protective-order.interfaces';
+export * from './batch-protective-order.interfaces';

package/dist/interfaces/smart/index.js

@@ -0,0 +1,19 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./smart-order.interfaces"), exports);
+__exportStar(require("./protective-order.interfaces"), exports);
+__exportStar(require("./batch-protective-order.interfaces"), exports);

package/dist/interfaces/smart/protective-order.interfaces.d.ts

@@ -0,0 +1,11 @@
+import { DecimalString } from '../common';
+export type HLProtectiveKind = 'tp' | 'sl';
+export interface ProtectiveOrderParams {
+    assetName: string;
+    kind: HLProtectiveKind;
+    isBuy: boolean;
+    sz: DecimalString;
+    price: DecimalString;
+    isMarket?: boolean;
+    isTestnet?: boolean;
+}

package/dist/interfaces/smart/protective-order.interfaces.js

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

package/dist/interfaces/smart/smart-order.interfaces.d.ts

@@ -0,0 +1,26 @@
+import { DecimalString, HLOid } from '../common';
+export type HLOrderSize = {
+    type: 'base';
+    sz: DecimalString;
+} | {
+    type: 'quote';
+    usdc: DecimalString;
+} | {
+    type: 'percent';
+    percent: DecimalString;
+};
+export interface InstantOrderParams {
+    assetName: string;
+    isBuy: boolean;
+    size: HLOrderSize;
+    reduceOnly?: boolean;
+    isTestnet?: boolean;
+    maxRetries?: number;
+    delayMs?: number;
+}
+export interface WaitOrderStatusOptions {
+    oid: HLOid;
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    isTestnet?: boolean;
+}

package/dist/interfaces/smart/smart-order.interfaces.js

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

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

@@ -0,0 +1,11 @@
+import { DecimalString } from '../common';
+export interface HLSpotBalance {
+    coin: string;
+    token: number;
+    hold: DecimalString;
+    total: DecimalString;
+    entryNtl: DecimalString;
+}
+export interface HLSpotClearinghouseState {
+    balances: HLSpotBalance[];
+}

package/dist/interfaces/spot/balance.interfaces.js

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

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

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

package/dist/interfaces/spot/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./balance.interfaces"), exports);
+__exportStar(require("./meta.interfaces"), exports);

package/dist/interfaces/{market.d.ts → spot/meta.interfaces.d.ts}

@@ -1,11 +1,12 @@
-import { DecimalString, HexString } from './common';
 export interface HLSpotTokenMeta {
     name: string;
     szDecimals: number;
     weiDecimals: number;
     index: number;
-    tokenId: HexString;
+    tokenId: string;
     isCanonical: boolean;
+    evmContract: string | null;
+    fullName: string | null;
 }
 export interface HLSpotMarketMeta {
     name: string;
@@ -18,7 +19,5 @@ export interface HLSpotMeta {
     universe: HLSpotMarketMeta[];
 }
 export interface HLSpotAssetSummary extends HLSpotMarketMeta {
-    szDecimals: number;
-    markPrice: DecimalString;
-    midPrice: DecimalString;
+    szDecimals?: number;
 }

package/dist/interfaces/spot/meta.interfaces.js

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

package/package.json

@@ -1,23 +1,48 @@
 {
   "name": "@syldel/hl-shared-types",
-  "version": "0.0.1",
-  "description": "Shared Hyperliquid types",
+  "version": "0.0.4",
+  "description": "Shared TypeScript interfaces and types for Hyperliquid integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Syldel/hl-shared-types.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Syldel/hl-shared-types/issues"
+  },
+  "homepage": "https://github.com/Syldel/hl-shared-types#readme",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "clean": "rm -rf dist",
+    "build": "npm run lint && npm run clean && tsc",
+    "prepublishOnly": "npm run build",
+    "release": "npm run build && npm version patch && npm publish"
   },
-  "keywords": ["hyperliquid", "trading", "types", "crypto", "exchange", "defi"],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "hyperliquid",
+    "trading",
+    "types",
+    "interfaces",
+    "crypto",
+    "exchange",
+    "defi"
+  ],
   "author": "Syl. D.",
   "license": "ISC",
   "devDependencies": {
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsonc": "^2.21.0",
     "eslint-plugin-prettier": "^5.5.5",
+    "jsonc-eslint-parser": "^2.4.2",
     "prettier": "^3.8.0",
     "typescript": "^5.3.3",
     "typescript-eslint": "^8.53.0"

package/dist/interfaces/account.d.ts

@@ -1,23 +0,0 @@
-import { DecimalString } from './common';
-export interface HLPerpPosition {
-    coin: string;
-    szi: DecimalString;
-    entryPx: DecimalString;
-    leverage: {
-        type: 'cross' | 'isolated';
-        value: number;
-    };
-    unrealizedPnl: DecimalString;
-    liquidationPx: DecimalString | null;
-    marginUsed: DecimalString;
-}
-export interface HLClearinghouseState {
-    marginSummary: {
-        accountValue: DecimalString;
-        totalMarginUsed: DecimalString;
-        withdrawable: DecimalString;
-    };
-    assetPositions: {
-        position: HLPerpPosition | null;
-    }[];
-}

package/dist/interfaces/common.d.ts

@@ -1,7 +0,0 @@
-export type DecimalString = string;
-export type HLOid = number;
-export type HexString = `0x${string}`;
-export interface HLSuccessResponse<T> {
-    status: 'ok';
-    response: T;
-}

package/dist/interfaces/dto.d.ts

@@ -1,32 +0,0 @@
-import { HLOrderDetailsDto } from './orders';
-export interface InstantOrderDto {
-    assetName: string;
-    isBuy: boolean;
-    size: {
-        type: 'base' | 'quote' | 'percent';
-        sz?: string;
-        usdc?: string;
-        percent?: string;
-    };
-    isTestnet?: boolean;
-}
-export interface ProtectiveOrderDto {
-    assetName: string;
-    kind: 'tp' | 'sl';
-    isBuy: boolean;
-    sz: string;
-    price: string;
-    isTestnet?: boolean;
-}
-export interface CancelOrderParams {
-    cancels: Array<{
-        asset: number;
-        oid: number;
-    }>;
-    isTestnet?: boolean;
-}
-export interface ModifyOrderDto {
-    oid: number;
-    order: HLOrderDetailsDto;
-    isTestnet?: boolean;
-}

package/dist/interfaces/orders.d.ts

@@ -1,15 +0,0 @@
-import { DecimalString, HLOid } from './common';
-export interface HLOrderDetailsDto {
-    assetName: string;
-    isBuy: boolean;
-    limitPx: DecimalString;
-    sz: DecimalString;
-    reduceOnly: boolean;
-}
-export interface HLOpenOrder {
-    coin: string;
-    limitPx: DecimalString;
-    oid: HLOid;
-    sz: DecimalString;
-    timestamp: number;
-}

package/dist/interfaces/responses.d.ts

@@ -1,37 +0,0 @@
-import { HLOid, DecimalString } from './common';
-export interface HLPlaceOrderResponse {
-    type: 'order';
-    data: {
-        statuses: Array<{
-            resting?: {
-                oid: HLOid;
-            };
-            filled?: {
-                oid: HLOid;
-                totalSz: DecimalString;
-                avgPx: DecimalString;
-            };
-            error?: string;
-        }>;
-    };
-}
-export interface HLSmartOrderResponse {
-    tp: {
-        cancelled: HLOid[];
-        created: HLOid[];
-        updated: HLOid[];
-    };
-    sl: {
-        cancelled: HLOid[];
-        created: HLOid[];
-        updated: HLOid[];
-    };
-}
-export interface HLCancelOrderResponse {
-    type: 'cancel';
-    data: {
-        statuses: ('success' | {
-            error: string;
-        })[];
-    };
-}