@syldel/hl-shared-types 0.0.3 → 0.0.4

package/README.md

@@ -1,8 +1,11 @@
-# @syldel/hl-types 🚀
+# @syldel/hl-shared-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`.
+<p style="display: flex; justify-content: center; gap: 24px;">
+    <a href="https://www.typescriptlang.org/" target="_blank"><img src="https://i.postimg.cc/28V1jRWW/typescript.png" alt="Typescript" height="120" /></a>
+    <a href="https://app.hyperliquid.xyz/" target="_blank"><img src="https://i.postimg.cc/prPKc0cg/HL-symbol-mint-green.png" alt="Hyperliquid" height="120" /></a>
+</p>
 
 ---
 
@@ -12,7 +15,6 @@ Inspiré par les standards de `nktkas/hyperliquid` et `nomeida/hyperliquid`.
 * **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).
 
 ---
 
@@ -34,9 +36,6 @@ Le projet utilise **ESLint** pour la logique et **Prettier** pour le formatage.
 ```bash
 # Vérifier les erreurs
 npx eslint .
-
-# Formater automatiquement
-npx prettier --write .
 ```
 
 ---
@@ -45,30 +44,19 @@ npx prettier --write .
 
 Pour utiliser ce package dans tes autres projets (`bot`, `gateway` ou `mobile`) sans le publier sur NPM :
 
-1.  Dans le dossier `hl-types` :
+1.  Dans le dossier `hl-shared-types` :
     ```bash
     npm link
     ```
 2.  Dans ton projet (ex: `my-trading-bot`) :
     ```bash
-    npm link @syldel/hl-types
+    npm link @syldel/hl-shared-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
@@ -96,6 +84,11 @@ La commande suivante automatise le build, l'incrémentation de version et l'envo
 npm run release
 ```
 
+### Pousse le commit ET le tag sur GitHub
+```bash
+git push origin main --follow-tags
+```
+
 ---
 
 ## 📝 Conventions de code
@@ -105,6 +98,3 @@ npm run release
 * **Types stricts** : Usage de `DecimalString` pour la précision financière.
 
 ---
-
-## ⚖️ Licence
-ISC

package/dist/interfaces/actions/modify.interfaces.d.ts

@@ -1,4 +1,5 @@
-import { HLApiOrder, HLOid } from '../orders';
+import { HLOid } from '../common';
+import { HLApiOrder } from '../orders';
 export interface HLModifyAction {
     type: 'modify';
     oid: HLOid;

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

@@ -0,0 +1,4 @@
+export type DecimalString = string;
+export type Timestamp = number;
+export type HexString = `0x${string}`;
+export type HLOid = number | HexString;

package/dist/interfaces/common/common.interfaces.js

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

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

@@ -0,0 +1 @@
+export * from './common.interfaces';

package/dist/interfaces/common/index.js

@@ -0,0 +1,17 @@
+"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("./common.interfaces"), exports);

package/dist/interfaces/index.d.ts

@@ -1,4 +1,5 @@
 export * from './actions/index';
+export * from './common/index';
 export * from './orders/index';
 export * from './params/index';
 export * from './responses/index';

package/dist/interfaces/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./actions/index"), exports);
+__exportStar(require("./common/index"), exports);
 __exportStar(require("./orders/index"), exports);
 __exportStar(require("./params/index"), exports);
 __exportStar(require("./responses/index"), exports);

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

@@ -1,12 +1,11 @@
-import { DecimalString } from './order-details.interfaces';
-export type HLOid = number | `0x${string}`;
+import { DecimalString, HLOid, Timestamp } from '../common';
 export interface HLOpenOrder {
     coin: string;
     limitPx: DecimalString;
     oid: HLOid;
     side: 'A' | 'B';
     sz: DecimalString;
-    timestamp: number;
+    timestamp: Timestamp;
 }
 export type HLOpenOrdersResponse = HLOpenOrder[];
 export interface HLFrontendOpenOrder extends HLOpenOrder {

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

@@ -1,4 +1,4 @@
-export type DecimalString = string;
+import { DecimalString } from '../common';
 /**
  * Détails d'un ordre à placer sur Hyperliquid.
  *

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

@@ -1,5 +1,4 @@
-import { HLOid } from './open-order.interfaces';
-import { DecimalString } from './order-details.interfaces';
+import { DecimalString, HLOid, Timestamp } from '../common';
 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;
@@ -7,7 +6,7 @@ export interface HLOrderStatusDetails {
     limitPx: DecimalString;
     sz: DecimalString;
     oid: HLOid;
-    timestamp: number;
+    timestamp: Timestamp;
     triggerCondition: string;
     isTrigger: boolean;
     triggerPx: DecimalString;
@@ -22,7 +21,7 @@ export interface HLOrderStatusDetails {
 export interface HLOrderStatusData {
     order: HLOrderStatusDetails;
     status: HLOrderStatus;
-    statusTimestamp: number;
+    statusTimestamp: Timestamp;
 }
 export interface HLOrderStatusResponse {
     status: 'order' | 'unknownOid';

package/dist/interfaces/orders/user-fills.interfaces.d.ts

@@ -1,9 +1,10 @@
+import { Timestamp } from '../common';
 export interface HLUserFill {
     coin: string;
     px: string;
     sz: string;
     side: 'A' | 'B';
-    time: number;
+    time: Timestamp;
     oid: number;
     tid: number;
     dir: string;

package/dist/interfaces/params/params.d.ts

@@ -0,0 +1,64 @@
+import { HLOrderGrouping } from '../actions';
+import { HLOid } from '../common';
+import { HLOrderDetails } from '../orders';
+export interface PlaceOrderParams {
+    order: HLOrderDetails;
+    grouping?: HLOrderGrouping;
+    builder?: {
+        b: string;
+        f: number;
+    };
+    isTestnet?: boolean;
+}
+export interface ModifyOrderItem {
+    oid: HLOid;
+    order: HLOrderDetails;
+}
+export interface ModifyOrderParams extends ModifyOrderItem {
+    isTestnet?: boolean;
+}
+export interface BatchModifyOrdersParams {
+    modifies: ModifyOrderItem[];
+    isTestnet?: boolean;
+}
+export interface CancelOrderParams {
+    cancels: {
+        asset: number;
+        oid: HLOid;
+    }[];
+    isTestnet?: boolean;
+}
+export interface CancelOrderByCloidParams {
+    cancels: {
+        asset: number;
+        cloid: string;
+    }[];
+    isTestnet?: boolean;
+}
+export interface UpdateLeverageParams {
+    asset: number;
+    isCross: boolean;
+    leverage: number;
+    isTestnet?: boolean;
+}
+export interface GetOpenOrdersQueryParams {
+    dex?: string;
+    isTestnet?: boolean;
+}
+export interface OrderStatusQueryParams {
+    isTestnet?: boolean;
+}
+export interface TransferSpotPerpParams {
+    amount: string;
+    toPerp: boolean;
+    isTestnet?: boolean;
+}
+export interface ProtectiveActionResult {
+    cancelled: HLOid[];
+    created: HLOid[];
+    updated: HLOid[];
+}
+export interface SmartOrderResponse {
+    tp: ProtectiveActionResult;
+    sl: ProtectiveActionResult;
+}

package/dist/interfaces/params/params.js

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

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

@@ -1,5 +1,4 @@
-import { DecimalString } from '../orders/order-details.interfaces';
-export type Timestamp = number;
+import { DecimalString, Timestamp } from '../common';
 export interface HLPerpLeverage {
     rawUsd: DecimalString;
     type: 'isolated' | 'cross';

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

@@ -1,4 +1,4 @@
-import { DecimalString } from '../orders';
+import { DecimalString } from '../common';
 export interface HLPerpMarketInfo {
     name: string;
     szDecimals: number;

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

@@ -1,12 +1,12 @@
-import { HLOid } from '../orders';
+import { DecimalString, HLOid } from '../common';
 export interface HLPlaceOrderStatus {
     resting?: {
         oid: HLOid;
     };
     filled?: {
         oid: HLOid;
-        totalSz: string;
-        avgPx: string;
+        totalSz: DecimalString;
+        avgPx: DecimalString;
     };
     error?: string;
 }

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

@@ -1,4 +1,5 @@
-import { DecimalString, HLOid, HLOrderDetails } from '../orders';
+import { DecimalString, HLOid } from '../common';
+import { HLOrderDetails } from '../orders';
 import { HLProtectiveKind } from './protective-order.interfaces';
 export interface BatchProtectiveOrderItem {
     sz: string;

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

@@ -1,4 +1,4 @@
-import { DecimalString } from '../orders';
+import { DecimalString } from '../common';
 export type HLProtectiveKind = 'tp' | 'sl';
 export interface ProtectiveOrderParams {
     assetName: string;

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

@@ -1,4 +1,4 @@
-import { DecimalString, HLOid } from '../orders';
+import { DecimalString, HLOid } from '../common';
 export type HLOrderSize = {
     type: 'base';
     sz: DecimalString;

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

@@ -1,4 +1,4 @@
-import { DecimalString } from '../orders/order-details.interfaces';
+import { DecimalString } from '../common';
 export interface HLSpotBalance {
     coin: string;
     token: number;

package/package.json

@@ -1,24 +1,40 @@
 {
   "name": "@syldel/hl-shared-types",
-  "version": "0.0.3",
-  "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",
-  "files": ["dist"],
+  "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": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "format:pkg": "eslint package.json --fix",
     "clean": "rm -rf dist",
     "build": "npm run lint && npm run clean && tsc",
-    "postversion": "npm run format:pkg",
     "prepublishOnly": "npm run build",
-    "release": "npm version patch && npm run build && npm publish"
+    "release": "npm run build && npm version patch && npm publish"
   },
   "publishConfig": {
     "access": "public"
   },
-  "keywords": ["hyperliquid", "trading", "types", "interfaces", "crypto", "exchange", "defi"],
+  "keywords": [
+    "hyperliquid",
+    "trading",
+    "types",
+    "interfaces",
+    "crypto",
+    "exchange",
+    "defi"
+  ],
   "author": "Syl. D.",
   "license": "ISC",
   "devDependencies": {