@syldel/hl-shared-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.

    

---

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.

---

Développement

Installation des dépendances

npm install

Compilation

Génère le dossier dist/ contenant les fichiers JavaScript et les déclarations de types (.d.ts).

npm run build

Qualité du code

Le projet utilise ESLint pour la logique et Prettier pour le formatage.

# Vérifier les erreurs
npx eslint .

---

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-shared-types :

   npm link

2. Dans ton projet (ex: my-trading-bot) :

   npm link @syldel/hl-shared-types

---

Publication

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.
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 :

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 :

npm run release

Pousse le commit ET le tag sur GitHub

git push origin main --follow-tags

---

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.

---