diff --git a/docs/INDEX.md b/docs/INDEX.md index d64ce4f..8aa32d7 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -2,24 +2,31 @@ Index complet de la documentation du SDK client pour les Silent Payments. +## 🚀 État Actuel + +### Migration WASM en cours +- ✅ **Stub WASM flate2** : Package temporaire compatible avec `sdk_signer` +- 🔄 **Migration complète** : Remplacement de `secp256k1-sys` par `k256` (en cours) +- ⏳ **WASM natif** : Compilation WebAssembly complète (planifié) + ## 📖 Guides Principaux ### 🚀 [Guide d'Installation](INSTALLATION.md) Guide complet pour installer et configurer le SDK client. - Prérequis système et logiciels - Installation de Rust et dépendances -- Configuration WASM et compilation +- Configuration du stub WASM - Tests post-installation - Dépannage et monitoring ### 📖 [Guide d'utilisation](USAGE.md) -Parcours d’utilisation, intégration et validations (sans exemples exécutables). +Parcours d'utilisation, intégration et validations (sans exemples exécutables). ### ⚙️ [Guide de Configuration](CONFIGURATION.md) Guide complet pour configurer le SDK selon vos besoins. - Configuration générale et variables d'environnement - Configuration Rust et Cargo -- Configuration WASM et wasm-pack +- Configuration du stub WASM - Configuration des features - Configuration de build - Configuration de tests @@ -30,7 +37,7 @@ Guide complet pour configurer le SDK selon vos besoins. ### 🏗️ [Architecture Technique](ARCHITECTURE.md) Documentation technique détaillée de l'architecture. - Architecture générale du SDK -- Composants principaux (Rust, WASM, JavaScript) +- Composants principaux (Rust, stub WASM) - Architecture des Silent Payments - Flux de données et types - Intégration avec sdk_common @@ -39,7 +46,11 @@ Documentation technique détaillée de l'architecture. - Monitoring et observabilité ### 📡 [Référence API](API.md) -Contrats publics WASM/Rust, structures, erreurs, invariants et limites. +Documentation du stub WASM et des APIs disponibles. +- **Stub WASM** : Implémentation JavaScript temporaire +- **Types TypeScript** : Interfaces et structures +- **Fonctions disponibles** : API du stub +- **Compatibilité** : Intégration avec sdk_signer ### 🔒 Sécurité Bonnes pratiques et audit: voir `SECURITY_AUDIT.md`. @@ -80,15 +91,17 @@ Roadmap de développement détaillée. ### 🧪 [Guide des Tests](TESTING.md) - Tests unitaires et intégration (cargo) -- Tests WASM (Windows): script `scripts/run-wasm-tests.ps1` (LLVM/Clang requis, runner wasm-bindgen) +- Tests du stub WASM +- Tests de compatibilité avec sdk_signer #### Commandes utiles ```bash # Tests natifs cargo test -``` -Pour les tests WASM, se référer au script PowerShell (voir détails dans `docs/TESTING.md`). +# Tests du stub WASM +npm test +``` ### 🔍 [Audit de Sécurité](SECURITY_AUDIT.md) Audit de sécurité détaillé. @@ -103,27 +116,8 @@ Audit de sécurité détaillé. ### 🔧 Développement Références réparties entre `ARCHITECTURE.md`, `API.md`, `TESTING.md`. -### 📋 [Référence Rapide](QUICK_REFERENCE.md) -Référence rapide pour les développeurs. -- **Commandes essentielles** -- **Structure du projet** -- **APIs principales** -- **Configuration rapide** -- **Dépannage rapide** - -### 🔄 [Guide de Migration](MIGRATION.md) -Guide pour les migrations et mises à jour. -- **Migration des versions** -- **Breaking changes** -- **Mise à jour des dépendances** -- **Migration des données** -- **Tests de migration** - ## 🌐 Guides d'Intégration -### 🔗 Intégrations externes -Références hors périmètre dans les dépôts d’infrastructure. - ### 🔑 [Configuration SSH](SSH_SETUP.md) Guide de configuration SSH pour le développement. - **Génération des clés SSH** @@ -138,19 +132,6 @@ Guide pour l'automatisation des pushes SSH. - **Gestion des clés** - **Sécurité et bonnes pratiques** -## 📊 État et Monitoring - -### 📊 [État Actuel](ETAT_ACTUEL.md) -État détaillé du projet sdk_client. -- **Statut des compilations** -- **Configuration des branches** -- **Fonctionnalités opérationnelles** -- **Métriques de performance** -- **Problèmes connus** - -### 📋 Résumé final -Récapitulatif si applicable. - ## 🔧 Guides d'Open Source ### ✅ [Checklist Open Source](OPEN_SOURCE_CHECKLIST.md) @@ -187,8 +168,7 @@ Guide de support et contact. ### 📚 Documentation 1. [Index](INDEX.md) - Cet index -2. [Quick Reference](QUICK_REFERENCE.md) - Référence rapide -3. [Roadmap](ROADMAP.md) - Évolution du projet +2. [Roadmap](ROADMAP.md) - Évolution du projet ### 🤝 Communauté 1. [Guide Communauté](COMMUNITY_GUIDE.md) - Contribuer @@ -217,14 +197,11 @@ cargo clippy -- -D warnings cargo fmt -- --check ``` -### Tests WASM +### Tests du Stub WASM ```bash -# Compilation WASM -wasm-pack build --target web - -# Tests WASM -wasm-pack test --headless --firefox -wasm-pack test --headless --chrome +# Tests de compatibilité avec sdk_signer +cd ../sdk_signer +npm test ``` --- @@ -239,9 +216,6 @@ cargo build # Build de production cargo build --release -# Compilation WASM -wasm-pack build --target web - # Tests cargo test --all ```