sdk_client/docs/INDEX.md

📚 Index de Documentation - sdk_client

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

Guide complet pour installer et configurer le SDK client.

• Prérequis système et logiciels
• Installation de Rust et dépendances
• Configuration du stub WASM
• Tests post-installation
• Dépannage et monitoring

📖 Guide d'utilisation

Parcours d'utilisation, intégration et validations (sans exemples exécutables).

⚙️ Guide de Configuration

Guide complet pour configurer le SDK selon vos besoins.

• Configuration générale et variables d'environnement
• Configuration Rust et Cargo
• Configuration du stub WASM
• Configuration des features
• Configuration de build
• Configuration de tests
• Configuration de sécurité

🔧 Guides Techniques

🏗️ Architecture Technique

Documentation technique détaillée de l'architecture.

• Architecture générale du SDK
• Composants principaux (Rust, stub WASM)
• Architecture des Silent Payments
• Flux de données et types
• Intégration avec sdk_common
• Sécurité et isolation
• Performance et optimisations
• Monitoring et observabilité

📡 Référence API

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.

🐙 Configuration Gitea

Guide de configuration spécifique pour Gitea.

• Configuration du repository Gitea
• Templates d'issues et pull requests
• Configuration CI/CD avec Gitea Actions
• Intégrations et webhooks
• Workflow de contribution
• Sécurité et permissions

🚀 Plan de Release

Plan de lancement open source complet.

• Phases de préparation
• Communication et marketing
• Checklist de lancement
• Support communautaire
• Gestion des risques

🌟 Guide de la Communauté

Guide complet pour la communauté.

• Comment contribuer
• Ressources d'apprentissage
• Environnement de développement
• Processus de contribution
• Support et reconnaissance

🗺️ Roadmap

Roadmap de développement détaillée.

• Timeline de développement
• Fonctionnalités planifiées
• Évolution de l'architecture
• Métriques de succès

🧪 Guides de Test

🧪 Guide des Tests

• Tests unitaires et intégration (cargo)
• Tests du stub WASM
• Tests de compatibilité avec sdk_signer

Commandes utiles

# Tests natifs
cargo test

# Tests du stub WASM
npm test

🔍 Audit de Sécurité

Audit de sécurité détaillé.

• Vulnérabilités connues
• Tests de pénétration
• Audit de code
• Recommandations de sécurité
• Plan de remédiation

🔧 Guides de Développement

🔧 Développement

Références réparties entre ARCHITECTURE.md, API.md, TESTING.md.

🌐 Guides d'Intégration

🔑 Configuration SSH

Guide de configuration SSH pour le développement.

• Génération des clés SSH
• Configuration Git
• Intégration avec Gitea
• Automatisation des déploiements

🤖 Push SSH Automatisé

Guide pour l'automatisation des pushes SSH.

• Configuration des scripts
• Intégration CI/CD
• Gestion des clés
• Sécurité et bonnes pratiques

🔧 Guides d'Open Source

✅ Checklist Open Source

Checklist complète pour l'ouverture en open source.

• Préparation du code
• Documentation
• Licences et légal
• Infrastructure
• Communication

📞 Support et Contact

📞 Support

Guide de support et contact.

• Comment obtenir de l'aide
• Création d'issues
• Canal de communication
• FAQ
• Ressources additionnelles

---

🎯 Navigation Rapide

🚀 Démarrage Rapide

1. Installation - Installer sdk_client
2. Configuration - Configurer l'environnement
3. Utilisation - Utiliser le SDK

🔧 Développement

1. Architecture - Comprendre l'architecture
2. API - Consulter les APIs
3. Tests - Exécuter les tests

📚 Documentation

1. Index - Cet index
2. Roadmap - Évolution du projet

🤝 Communauté

1. Guide Communauté - Contribuer
2. Code de Conduite - Règles de conduite
3. Support - Obtenir de l'aide

---

🧪 Tests et Validation

Tests Automatisés

# Tests unitaires
cargo test --all

# Tests d'intégration
cargo test --test integration

# Tests de performance
cargo test --test performance

# Linting
cargo clippy -- -D warnings

# Formatage
cargo fmt -- --check

Tests du Stub WASM

# Tests de compatibilité avec sdk_signer
cd ../sdk_signer
npm test

---

🚀 Développement

Commandes Essentielles

# Build de développement
cargo build

# Build de production
cargo build --release

# Tests
cargo test --all

---

📚 Documentation complète pour sdk_client — SDK client pour les Silent Payments 🚀