@syldel/hl-shared-types 0.0.1

package/LICENSE.MD

@@ -0,0 +1,5 @@
+Copyright (c) 2026, Syl-Studio Inc. c/o Syl. D.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# @syldel/hl-types 🚀
+
+Ce package centralise les définitions TypeScript pour l'écosystème **Hyperliquid**. Il sert de source de vérité unique pour les interfaces d'API, les types de la blockchain (L1) et les DTOs de communication entre le Gateway, le Bot de trading et l'application mobile.
+
+Inspiré par les standards de `nktkas/hyperliquid` et `nomeida/hyperliquid`.
+
+---
+
+## 🛠 Structure du projet
+
+* **Common** : Types de base (Hex, DecimalStrings, ID d'ordres).
+* **Account** : États du compte, positions Perp et soldes Spot.
+* **Market** : Métadonnées des actifs et résumés de marché.
+* **Orders** : Définitions des ordres ouverts et historiques.
+* **DTO** : Objets de transfert de données pour les requêtes API (NestJS).
+
+---
+
+## 👨‍💻 Développement
+
+### Installation des dépendances
+```bash
+npm install
+```
+
+### Compilation
+Génère le dossier `dist/` contenant les fichiers JavaScript et les déclarations de types (`.d.ts`).
+```bash
+npm run build
+```
+
+### Qualité du code
+Le projet utilise **ESLint** pour la logique et **Prettier** pour le formatage.
+```bash
+# Vérifier les erreurs
+npx eslint .
+
+# Formater automatiquement
+npx prettier --write .
+```
+
+---
+
+## 🔗 Utilisation en local (Development Workflow)
+
+Pour utiliser ce package dans tes autres projets (`bot`, `gateway` ou `mobile`) sans le publier sur NPM :
+
+1.  Dans le dossier `hl-types` :
+    ```bash
+    npm link
+    ```
+2.  Dans ton projet (ex: `my-trading-bot`) :
+    ```bash
+    npm link @syldel/hl-types
+    ```
+
+---
+
+## 📦 Publication
+
+### 1. Préparer la version
+Mets à jour la version dans le `package.json` (ex: `1.0.0`), puis :
+```bash
+npm run build
+```
+
+### 2. Publier sur NPM (Public)
+```bash
+npm publish --access public
+```
+
+Le projet utilise des **Granular Access Tokens** pour la publication afin de contourner la double authentification (2FA) manuelle tout en maintenant une sécurité maximale.
+
+### Configuration du Token
+1. Générer un token sur NPM avec les permissions `Read and Write`.
+2. Restreindre l'accès au package `@syldel/hl-shared-types` uniquement.
+
+### Commande de publication rapide
+Si tu n'utilises pas de fichier `.npmrc`, tu peux publier en passant le token directement :
+```bash
+npm publish --access public --//registry.npmjs.org/:_authToken=TON_TOKEN_ICI
+```
+
+---
+
+## 📝 Conventions de code
+
+* **Sauts de ligne** : Une ligne vide est automatiquement insérée entre chaque `interface` pour une meilleure lisibilité.
+* **Naming** : Toutes les interfaces commencent par `HL`.
+* **Types stricts** : Usage de `DecimalString` pour la précision financière.
+
+---
+
+## ⚖️ Licence
+ISC

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './interfaces/common';
+export * from './interfaces/account';
+export * from './interfaces/market';
+export * from './interfaces/orders';
+export * from './interfaces/responses';
+export * from './interfaces/dto';

package/dist/index.js

@@ -0,0 +1,22 @@
+"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("./interfaces/common"), exports);
+__exportStar(require("./interfaces/account"), exports);
+__exportStar(require("./interfaces/market"), exports);
+__exportStar(require("./interfaces/orders"), exports);
+__exportStar(require("./interfaces/responses"), exports);
+__exportStar(require("./interfaces/dto"), exports);

package/dist/interfaces/account.d.ts

@@ -0,0 +1,23 @@
+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/account.js

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

package/dist/interfaces/common.d.ts

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

package/dist/interfaces/common.js

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

package/dist/interfaces/dto.d.ts

@@ -0,0 +1,32 @@
+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/dto.js

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

package/dist/interfaces/market.d.ts

@@ -0,0 +1,24 @@
+import { DecimalString, HexString } from './common';
+export interface HLSpotTokenMeta {
+    name: string;
+    szDecimals: number;
+    weiDecimals: number;
+    index: number;
+    tokenId: HexString;
+    isCanonical: boolean;
+}
+export interface HLSpotMarketMeta {
+    name: string;
+    tokens: [number, number];
+    index: number;
+    isCanonical: boolean;
+}
+export interface HLSpotMeta {
+    tokens: HLSpotTokenMeta[];
+    universe: HLSpotMarketMeta[];
+}
+export interface HLSpotAssetSummary extends HLSpotMarketMeta {
+    szDecimals: number;
+    markPrice: DecimalString;
+    midPrice: DecimalString;
+}

package/dist/interfaces/market.js

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

package/dist/interfaces/orders.d.ts

@@ -0,0 +1,15 @@
+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/orders.js

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

package/dist/interfaces/responses.d.ts

@@ -0,0 +1,37 @@
+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;
+        })[];
+    };
+}

package/dist/interfaces/responses.js

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

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@syldel/hl-shared-types",
+  "version": "0.0.1",
+  "description": "Shared Hyperliquid types",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": ["hyperliquid", "trading", "types", "crypto", "exchange", "defi"],
+  "author": "Syl. D.",
+  "license": "ISC",
+  "devDependencies": {
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "prettier": "^3.8.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.53.0"
+  }
+}