@syldel/hl-shared-types 0.0.1 → 0.0.3

package/README.md

@@ -74,6 +74,7 @@ Le projet utilise des **Granular Access Tokens** pour la publication afin de con
 ### 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.
+3. Utiliser l'option `Bypass 2FA` pour permettre l'automatisation.
 
 ### Commande de publication rapide
 Si tu n'utilises pas de fichier `.npmrc`, tu peux publier en passant le token directement :
@@ -81,6 +82,20 @@ Si tu n'utilises pas de fichier `.npmrc`, tu peux publier en passant le token di
 npm publish --access public --//registry.npmjs.org/:_authToken=TON_TOKEN_ICI
 ```
 
+### Configuration de la publication
+Créez un fichier .npmrc à la racine (ignoré par Git) pour l'authentification :
+
+```
+//registry.npmjs.org/:_authToken=npm_votre_token_ici
+```
+
+### Publier une nouvelle version
+La commande suivante automatise le build, l'incrémentation de version et l'envoi vers NPM :
+
+```bash
+npm run release
+```
+
 ---
 
 ## 📝 Conventions de code

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,9 +14,4 @@ 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);
+__exportStar(require("./interfaces"), exports);

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

@@ -0,0 +1,14 @@
+export interface HLCancelAction {
+    type: 'cancel';
+    cancels: Array<{
+        a: number;
+        o: number;
+    }>;
+}
+export interface HLCancelByCloidAction {
+    type: 'cancelByCloid';
+    cancels: Array<{
+        asset: number;
+        cloid: string;
+    }>;
+}

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

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

package/dist/interfaces/actions/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("./order.interfaces"), exports);
+__exportStar(require("./cancel.interfaces"), exports);
+__exportStar(require("./modify.interfaces"), exports);
+__exportStar(require("./transfer.interfaces"), exports);

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

@@ -0,0 +1,25 @@
+import { HLApiOrder, HLOid } from '../orders';
+export interface HLModifyAction {
+    type: 'modify';
+    oid: HLOid;
+    order: HLApiOrder;
+}
+export interface HLBatchModifyAction {
+    type: 'batchModify';
+    modifies: Array<{
+        oid: HLOid;
+        order: HLApiOrder;
+    }>;
+}
+export interface HLUpdateLeverageAction {
+    type: 'updateLeverage';
+    asset: number;
+    isCross: boolean;
+    leverage: number;
+}
+export interface HLUpdateIsolatedMarginAction {
+    type: 'updateIsolatedMargin';
+    asset: number;
+    isBuy: boolean;
+    ntli: number;
+}

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

@@ -0,0 +1,12 @@
+import { HLApiOrder } from '../orders/order-details.interfaces';
+export type HLOrderGrouping = 'na' | 'normalTpsl' | 'positionTpsl';
+export type HLOrderBuilder = {
+    b: string;
+    f: number;
+};
+export interface HLOrderAction {
+    type: 'order';
+    orders: HLApiOrder[];
+    grouping: HLOrderGrouping;
+    builder?: HLOrderBuilder;
+}

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

@@ -0,0 +1,94 @@
+export interface HLUsdClassTransferAction {
+    type: 'usdClassTransfer';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    amount: string;
+    toPerp: boolean;
+    nonce: number;
+}
+export interface HLSpotSendAction {
+    type: 'spotSend';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    destination: string;
+    token: string;
+    amount: string;
+    time: number;
+}
+export interface HLSendAssetAction {
+    type: 'sendAsset';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    destination: string;
+    sourceDex: string;
+    destinationDex: string;
+    token: string;
+    amount: string;
+    fromSubAccount: string;
+    nonce: number;
+}
+export interface HLCDepositAction {
+    type: 'cDeposit';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    wei: number;
+    nonce: number;
+}
+export interface HLCWithdrawAction {
+    type: 'cWithdraw';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    wei: number;
+    nonce: number;
+}
+export interface HLTokenDelegateAction {
+    type: 'tokenDelegate';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    validator: string;
+    isUndelegate: boolean;
+    wei: number;
+    nonce: number;
+}
+export interface HLVaultTransferAction {
+    type: 'vaultTransfer';
+    vaultAddress: string;
+    isDeposit: boolean;
+    usd: number;
+}
+export interface HLApproveAgentAction {
+    type: 'approveAgent';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    agentAddress: string;
+    agentName?: string;
+    nonce: number;
+}
+export interface HLApproveBuilderFeeAction {
+    type: 'approveBuilderFee';
+    hyperliquidChain: 'Mainnet' | 'Testnet';
+    signatureChainId: string;
+    maxFeeRate: string;
+    builder: string;
+    nonce: number;
+}
+export interface HLTwapOrderAction {
+    type: 'twapOrder';
+    twap: {
+        a: number;
+        b: boolean;
+        s: string;
+        r: boolean;
+        m: number;
+        t: boolean;
+    };
+}
+export interface HLTwapCancelAction {
+    type: 'twapCancel';
+    a: number;
+    t: number;
+}
+export interface HLReserveRequestWeightAction {
+    type: 'reserveRequestWeight';
+    weight: number;
+}

package/dist/interfaces/actions/transfer.interfaces.js

@@ -0,0 +1,10 @@
+"use strict";
+// export interface HLUsdSendAction {
+//   type: 'usdSend';
+//   hyperliquidChain: 'Mainnet' | 'Testnet';
+//   signatureChainId: string;
+//   destination: string;
+//   amount: string;
+//   time: number;
+// }
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/index.d.ts

@@ -0,0 +1,7 @@
+export * from './actions/index';
+export * from './orders/index';
+export * from './params/index';
+export * from './responses/index';
+export * from './spot/index';
+export * from './perp/index';
+export * from './smart/index';

package/dist/interfaces/index.js

@@ -0,0 +1,23 @@
+"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("./actions/index"), exports);
+__exportStar(require("./orders/index"), exports);
+__exportStar(require("./params/index"), exports);
+__exportStar(require("./responses/index"), exports);
+__exportStar(require("./spot/index"), exports);
+__exportStar(require("./perp/index"), exports);
+__exportStar(require("./smart/index"), exports);

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

@@ -0,0 +1,4 @@
+export * from './order-details.interfaces';
+export * from './order-status.interfaces';
+export * from './open-order.interfaces';
+export * from './user-fills.interfaces';

package/dist/interfaces/orders/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("./order-details.interfaces"), exports);
+__exportStar(require("./order-status.interfaces"), exports);
+__exportStar(require("./open-order.interfaces"), exports);
+__exportStar(require("./user-fills.interfaces"), exports);

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

@@ -0,0 +1,21 @@
+import { DecimalString } from './order-details.interfaces';
+export type HLOid = number | `0x${string}`;
+export interface HLOpenOrder {
+    coin: string;
+    limitPx: DecimalString;
+    oid: HLOid;
+    side: 'A' | 'B';
+    sz: DecimalString;
+    timestamp: number;
+}
+export type HLOpenOrdersResponse = HLOpenOrder[];
+export interface HLFrontendOpenOrder extends HLOpenOrder {
+    isPositionTpsl: boolean;
+    isTrigger: boolean;
+    orderType: 'Limit' | 'Market';
+    origSz: DecimalString;
+    reduceOnly: boolean;
+    triggerCondition: string;
+    triggerPx: DecimalString;
+}
+export type HLFrontendOpenOrdersResponse = HLFrontendOpenOrder[];

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

@@ -0,0 +1,69 @@
+export type DecimalString = string;
+/**
+ * Détails d'un ordre à placer sur Hyperliquid.
+ *
+ * @interface HLOrderDetails
+ *
+ * @property {number} asset - Identifiant numérique de l'actif à trader.
+ * @property {boolean} isBuy - True pour un ordre d'achat, false pour un ordre de vente.
+ * @property {DecimalString} limitPx - Prix limite pour l'ordre (pour limit orders).
+ * @property {DecimalString} sz - Taille (quantité) de l'ordre.
+ * @property {boolean} reduceOnly - True si l'ordre est uniquement pour réduire une position existante.
+ * @property { { limit: { tif: 'Alo' | 'Ioc' | 'Gtc' } } | { trigger: { isMarket: boolean, triggerPx: DecimalString, tpsl: 'tp' | 'sl' } } } orderType
+ *   - Type d'ordre :
+ *     - **Limit Order** : { limit: { tif } } où `tif` définit le comportement du temps de vie de l'ordre :
+ *
+ *       | TIF | Comportement |
+ *       |-----|--------------|
+ *       | **Alo** | Post-only, annule si risque d’exécution immédiate |
+ *       | **Ioc** | Immediate or Cancel, exécute ce qui peut être pris, annule le reste |
+ *       | **Gtc** | Good Till Cancelled, reste sur le carnet jusqu’à annulation manuelle ou exécution |
+ *
+ *     - **Trigger Order** : { trigger: { isMarket, triggerPx, tpsl } } pour TP/SL
+ *       - `isMarket` : True si l'ordre se déclenche au prix du marché
+ *       - `triggerPx` : Prix de déclenchement
+ *       - `tpsl` : "tp" pour Take Profit, "sl" pour Stop Loss
+ * @property {string} [cloid] - Client Order ID optionnel (128-bit hex string, ex. "0x1234...").
+ */
+export interface HLOrderDetails {
+    assetName: string;
+    isBuy: boolean;
+    limitPx: DecimalString;
+    sz: DecimalString;
+    reduceOnly: boolean;
+    orderType: {
+        limit: {
+            tif: 'Alo' | 'Ioc' | 'Gtc';
+        };
+    } | {
+        trigger: {
+            isMarket: boolean;
+            triggerPx: DecimalString;
+            tpsl: 'tp' | 'sl';
+        };
+    };
+    cloid?: string;
+}
+/**
+ * Représente un ordre formaté pour l'API Hyperliquid.
+ * Les clés correspondent exactement à ce que l'API attend.
+ */
+export interface HLApiOrder {
+    a: number;
+    b: boolean;
+    p: DecimalString;
+    s: DecimalString;
+    r: boolean;
+    t: {
+        limit: {
+            tif: 'Alo' | 'Ioc' | 'Gtc';
+        };
+    } | {
+        trigger: {
+            isMarket: boolean;
+            triggerPx: DecimalString;
+            tpsl: 'tp' | 'sl';
+        };
+    };
+    c?: string;
+}

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

@@ -0,0 +1,35 @@
+import { HLOid } from './open-order.interfaces';
+import { DecimalString } from './order-details.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: number;
+    triggerCondition: string;
+    isTrigger: boolean;
+    triggerPx: DecimalString;
+    children: unknown[];
+    isPositionTpsl: boolean;
+    reduceOnly: boolean;
+    orderType: string;
+    origSz: DecimalString;
+    tif: string;
+    cloid: string | null;
+}
+export interface HLOrderStatusData {
+    order: HLOrderStatusDetails;
+    status: HLOrderStatus;
+    statusTimestamp: number;
+}
+export interface HLOrderStatusResponse {
+    status: 'order' | 'unknownOid';
+    order: HLOrderStatusData;
+}
+export interface HLOrderStatusRequest {
+    type: 'orderStatus';
+    user: `0x${string}`;
+    oid: HLOid;
+}

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

@@ -0,0 +1,18 @@
+export interface HLUserFill {
+    coin: string;
+    px: string;
+    sz: string;
+    side: 'A' | 'B';
+    time: number;
+    oid: number;
+    tid: number;
+    dir: string;
+    startPosition: string;
+    closedPnl: string;
+    crossed: boolean;
+    hash: `0x${string}`;
+    fee: string;
+    feeToken: string;
+    builderFee?: string;
+}
+export type HLUserFillsResponse = HLUserFill[];

package/dist/interfaces/orders/user-fills.interfaces.js

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

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

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

package/dist/interfaces/params/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("./signature.interfaces"), exports);

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

@@ -0,0 +1,13 @@
+export interface HLSignature {
+    v: number;
+    r: string;
+    s: string;
+}
+/** ECDSA signature components. */
+export interface HLParams<T> {
+    action: T;
+    nonce: number;
+    signature: HLSignature;
+    vaultAddress?: string | null;
+    expiresAfter?: number;
+}

package/dist/interfaces/params/signature.interfaces.js

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

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

@@ -0,0 +1,43 @@
+import { DecimalString } from '../orders/order-details.interfaces';
+export type Timestamp = number;
+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 '../orders';
+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 { HLOid } from '../orders';
+export interface HLPlaceOrderStatus {
+    resting?: {
+        oid: HLOid;
+    };
+    filled?: {
+        oid: HLOid;
+        totalSz: string;
+        avgPx: string;
+    };
+    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,30 @@
+import { DecimalString, HLOid, 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 '../orders';
+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 '../orders';
+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 '../orders/order-details.interfaces';
+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,32 @@
 {
   "name": "@syldel/hl-shared-types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Shared Hyperliquid types",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "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"
   },
-  "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;
-        })[];
-    };
-}