Update: Documentation et configuration - Ajout de l'état des services (etat_services.md) - Mise à jour du README et .gitignore - Mise à jour de repos.csv - Nettoyage de la documentation obsolète

This commit is contained in:
Debian 2025-09-03 22:26:25 +00:00
parent 02c470e3e0
commit e27867dd43
9 changed files with 148 additions and 839 deletions

2
.gitignore vendored
View File

@ -10,3 +10,5 @@ sdk_relay/
sdk_signer/
sdk_signer_client/
sdk_storage/
blindbit-oracle/
sp-client/

View File

@ -112,3 +112,5 @@ cd 4NK_node && ./scripts/manage_services.sh stop
## 📄 Licence
MIT License - voir les fichiers LICENSE individuels dans chaque projet.

View File

@ -1,272 +0,0 @@
# Analyse Complète et Plan de Nettoyage de la Documentation
## 📊 Analyse Exhaustive - 268 Fichiers Markdown
### 🔍 Projets Analysés
#### **1. 4NK_node (32 fichiers)**
- ✅ **INDEX.md** : Documentation complète et bien structurée
- ✅ **docs/scripts/manage_services.md** : Documentation correcte
- ❌ **docs/archive/** : 10 fichiers obsolètes à supprimer
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **2. 4NK_template (18 fichiers)**
- ❌ **INDEX.md** : Vide (3 lignes)
- ❌ **docs/templates/** : 10 fichiers templates génériques
- ❌ **docs/project/** : 7 fichiers non personnalisés
#### **3. 4NK_wallet (15 fichiers)**
- ❌ **INDEX.md** : Documentation minimale, non personnalisée
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **4. ihm_client (25 fichiers)**
- ✅ **INDEX.md** : Documentation complète et bien structurée
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **5. sdk_client (25 fichiers)**
- ✅ **INDEX.md** : Corrigé pour refléter l'état du stub WASM
- ❌ **docs/templates/** : 10 fichiers templates génériques
- ❌ **MIGRATION.md** : Supprimé (référence incorrecte)
#### **6. sdk_common (25 fichiers)**
- ✅ **INDEX.md** : Corrigé, liens mis à jour
- ✅ **API.md** : Corrigé, vraies APIs sdk_common
- ✅ **USAGE.md** : Corrigé, utilisation Rust uniquement
- ❌ **docs/templates/** : 10 fichiers templates génériques
- ❌ **docs/archive/** : 4 fichiers obsolètes
#### **7. sdk_relay (25 fichiers)**
- ❌ **INDEX.md** : Documentation complète mais références inexistantes
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **8. sdk_signer (15 fichiers)**
- ✅ **INDEX.md** : Complètement réécrit, documentation personnalisée
- ✅ **docker-support.md** : Documentation correcte
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **9. sdk_signer_client (15 fichiers)**
- ❌ **INDEX.md** : Template générique non personnalisé
- ❌ **docs/templates/** : 10 fichiers templates génériques
#### **10. sdk_storage (25 fichiers)**
- ✅ **README.md** : Documentation correcte et bien structurée
- ✅ **api_json_spec.md** : Documentation technique correcte
- ❌ **docs/templates/** : 10 fichiers templates génériques
- ❌ **guides_*.md** : 3 fichiers fragmentés à consolider
## 🎯 Plan de Nettoyage Complet
### **Phase 1 : Suppression des Fichiers Obsolètes (Priorité 1)**
#### **Fichiers Archive à Supprimer**
```bash
# 4NK_node/archive/docs/ (10 fichiers)
- COMMANDES_REDEMARRAGE.md
- CONFIGURATION_DEV3.md
- EXEMPLES_PRATIQUES.md
- INTEGRATION_DEV3_FINAL.md
- README_RESTART_SCRIPT.md
- RESUME_AJOUT_DEV3.md
- RESUME_DECOUVERTE_NOEUDS.md
- RESUME_SCRIPT_RESTART.md
- RESUME_TEST_3_RELAIS.md
- explain_node_discovery.md
# sdk_common/archive/docs/ (4 fichiers)
- AUTO_SSH_PUSH.md
- MIGRATION.md
- QUICK_REFERENCE.md
- SSH_USATE.md
```
#### **Fichiers Templates à Supprimer**
```bash
# Tous les projets (100 fichiers templates)
- docs/templates/API.md
- docs/templates/ARCHITECTURE.md
- docs/templates/CONFIGURATION.md
- docs/templates/INDEX.md
- docs/templates/OPEN_SOURCE_CHECKLIST.md
- docs/templates/README.md
- docs/templates/RELEASE_PLAN.md
- docs/templates/SECURITY_AUDIT.md
- docs/templates/TESTING.md
- docs/templates/USAGE.md
```
### **Phase 2 : Correction des Documentation Incomplètes (Priorité 2)**
#### **4NK_template**
```bash
# INDEX.md vide
- Créer une vraie documentation pour 4NK_template
- Supprimer les fichiers project/ non personnalisés
```
#### **4NK_wallet**
```bash
# INDEX.md minimal
- Créer une documentation complète pour 4NK_wallet
- Personnaliser les fichiers existants
```
#### **sdk_signer_client**
```bash
# INDEX.md template générique
- Créer une documentation personnalisée complète
- Adapter aux spécificités du projet
```
#### **sdk_relay**
```bash
# INDEX.md avec références inexistantes
- Corriger les liens vers fichiers existants
- Supprimer les références aux fichiers inexistants
```
### **Phase 3 : Consolidation des Documentation Fragmentées (Priorité 3)**
#### **sdk_storage**
```bash
# Fichiers fragmentés à consolider
- guides_principaux.md → Intégrer dans README.md
- guides_techniques.md → Intégrer dans README.md
- guides_test.md → Intégrer dans README.md
```
### **Phase 4 : Amélioration des Documentation Existantes (Priorité 4)**
#### **Documentation Correcte à Garder**
- ✅ **4NK_node/docs/** : Bien structuré, garder
- ✅ **ihm_client/docs/** : Bien structuré, garder
- ✅ **sdk_common/docs/** : Corrigé, garder
- ✅ **sdk_client/docs/** : Corrigé, garder
- ✅ **sdk_signer/docs/** : Créé, garder
- ✅ **sdk_storage/docs/** : Bien structuré, garder
## 📋 Actions Spécifiques par Projet
### **1. 4NK_node**
```bash
# Actions
- Supprimer docs/archive/ (10 fichiers)
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation principale (bien structurée)
```
### **2. 4NK_template**
```bash
# Actions
- Créer une vraie documentation INDEX.md
- Supprimer docs/templates/ (10 fichiers)
- Supprimer docs/project/ (7 fichiers non personnalisés)
- Créer une documentation spécifique au template
```
### **3. 4NK_wallet**
```bash
# Actions
- Créer une documentation complète INDEX.md
- Supprimer docs/templates/ (10 fichiers)
- Personnaliser les fichiers existants
```
### **4. ihm_client**
```bash
# Actions
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation principale (bien structurée)
```
### **5. sdk_client**
```bash
# Actions
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation corrigée
```
### **6. sdk_common**
```bash
# Actions
- Supprimer docs/archive/ (4 fichiers)
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation corrigée
```
### **7. sdk_relay**
```bash
# Actions
- Corriger INDEX.md (supprimer références inexistantes)
- Supprimer docs/templates/ (10 fichiers)
- Créer une documentation cohérente
```
### **8. sdk_signer**
```bash
# Actions
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation créée
```
### **9. sdk_signer_client**
```bash
# Actions
- Créer une documentation complète INDEX.md
- Supprimer docs/templates/ (10 fichiers)
- Personnaliser pour le projet
```
### **10. sdk_storage**
```bash
# Actions
- Consolider guides_*.md dans README.md
- Supprimer docs/templates/ (10 fichiers)
- Garder la documentation technique correcte
```
## 📊 Statistiques Finales
### **Avant Nettoyage**
- **Total fichiers** : 268
- **Fichiers archive** : 14
- **Fichiers templates** : 100
- **Documentation correcte** : ~154
### **Après Nettoyage**
- **Total fichiers** : ~154
- **Fichiers archive** : 0 (supprimés)
- **Fichiers templates** : 0 (supprimés)
- **Documentation correcte** : ~154
### **Réduction** : ~42% de fichiers supprimés
## 🚀 Implémentation
### **Ordre d'exécution**
1. **Suppression des archives** (14 fichiers)
2. **Suppression des templates** (100 fichiers)
3. **Correction des INDEX.md incomplets** (4 projets)
4. **Consolidation des fragments** (sdk_storage)
5. **Validation finale**
### **Validation**
- Vérifier que tous les liens fonctionnent
- S'assurer que la documentation reflète l'état actuel
- Tester la cohérence entre les projets
- Valider avec les développeurs
## 📝 Notes
- **Préserver** : Documentation technique correcte et bien structurée
- **Supprimer** : Fichiers archive, templates génériques, références inexistantes
- **Corriger** : Documentation incomplète ou incorrecte
- **Créer** : Documentation manquante pour les projets sans documentation
## 🎯 Objectif Final
**Documentation propre, cohérente et maintenable** avec :
- ✅ **0 fichier archive obsolète**
- ✅ **0 fichier template générique**
- ✅ **100% de liens fonctionnels**
- ✅ **Documentation personnalisée pour chaque projet**
- ✅ **Réduction de 42% du volume de fichiers**

View File

@ -1,268 +0,0 @@
# Analyse Finale et Plan de Nettoyage Complet de la Documentation
## 📊 Analyse Exhaustive - 142 Fichiers .md (hors INDEX.md)
### 🔍 Problèmes Identifiés par Projet
#### **1. sdk_client (18 fichiers)**
- ❌ **API.md** : 891 lignes, références à des APIs WASM complètes qui n'existent pas (stub actuel)
- ❌ **ARCHITECTURE.md** : 494 lignes, architecture Bitcoin Core/Blindbit qui ne correspond pas au projet
- ❌ **USAGE.md** : 276 lignes, références à wasm-pack et compilation WASM complète
- ❌ **INSTALLATION.md** : 311 lignes, instructions détaillées pour WASM complet
- ❌ **CONFIGURATION.md** : Références à des features WASM inexistantes
- ❌ **TESTING.md** : Tests WASM headless qui ne s'appliquent pas au stub
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **2. sdk_common (18 fichiers)**
- ❌ **ARCHITECTURE.md** : 575 lignes, références à SilentPayment, Wallet, Transaction qui n'existent pas
- ❌ **INSTALLATION.md** : 426 lignes, instructions pour WASM complet
- ❌ **CONFIGURATION.md** : Configuration WASM détaillée
- ❌ **TESTING.md** : Tests WASM qui ne s'appliquent pas
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **3. sdk_signer (8 fichiers)**
- ✅ **docker-support.md** : Documentation correcte et à jour
- ✅ **deployment.md** : Documentation correcte
- ✅ **release-notes-0.1.1.md** : Notes de version correctes
- ✅ **template-alignment.md** : Documentation d'alignement correcte
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **4. sdk_storage (15 fichiers)**
- ✅ **README.md** : Documentation correcte et bien structurée
- ✅ **api_json_spec.md** : Documentation technique correcte
- ✅ **architecture.md** : Documentation technique correcte
- ✅ **configuration.md** : Documentation correcte
- ✅ **demarrage_rapide.md** : Documentation correcte
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **5. sdk_relay (18 fichiers)**
- ❌ **API.md** : Références à Bitcoin Core RPC et Blindbit qui ne correspondent pas au projet
- ❌ **ARCHITECTURE.md** : Architecture Bitcoin Core/Blindbit incorrecte
- ❌ **USAGE.md** : Instructions pour services Bitcoin Core
- ❌ **INSTALLATION.md** : Installation Bitcoin Core détaillée
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **6. sdk_signer_client (8 fichiers)**
- ❌ **Tous les fichiers** : Templates génériques non personnalisés
#### **7. 4NK_node (18 fichiers)**
- ❌ **API.md** : 796 lignes, APIs Bitcoin Core RPC détaillées
- ❌ **USAGE.md** : 684 lignes, instructions Bitcoin Core/Blindbit
- ❌ **ARCHITECTURE.md** : Architecture Bitcoin Core/Blindbit
- ❌ **CONFIGURATION.md** : Configuration Bitcoin Core détaillée
- ❌ **Tous les autres fichiers** : Templates génériques non personnalisés
#### **8. 4NK_template (8 fichiers)**
- ❌ **Tous les fichiers** : Templates génériques non personnalisés
#### **9. 4NK_wallet (8 fichiers)**
- ❌ **Tous les fichiers** : Templates génériques non personnalisés
#### **10. ihm_client (18 fichiers)**
- ❌ **Tous les fichiers** : Templates génériques non personnalisés
## 🎯 Plan de Nettoyage Final
### **Phase 1 : Suppression des Templates Génériques (Priorité 1)**
#### **Fichiers à Supprimer (100+ fichiers)**
```bash
# Tous les fichiers templates génériques dans tous les projets
- COMMUNITY_GUIDE.md
- RELEASE_PLAN.md
- ROADMAP.md
- SECURITY_AUDIT.md
- SSH_SETUP.md
- SSH_USAGE.md
- AUTO_SSH_PUSH.md
- GITEA_SETUP.md
- OPEN_SOURCE_CHECKLIST.md
- QUICK_REFERENCE.md
- DEVELOPMENT.md
- PERFORMANCE.md
- TROUBLESHOOTING.md
- SUPPORT.md
- EXTERNAL_NODES.md
- RELAY_NETWORK.md
- EXEMPLES_PRATIQUES.md
- AGENTS_INTEGRATION.md
```
### **Phase 2 : Correction des Documentation Incorrectes (Priorité 2)**
#### **sdk_client**
```bash
# Fichiers à corriger complètement
- API.md → Adapter pour le stub WASM
- ARCHITECTURE.md → Architecture du stub WASM
- USAGE.md → Utilisation du stub WASM
- INSTALLATION.md → Installation du stub WASM
- CONFIGURATION.md → Configuration du stub WASM
- TESTING.md → Tests du stub WASM
```
#### **sdk_common**
```bash
# Fichiers à corriger complètement
- ARCHITECTURE.md → Architecture réelle (Process, Member, etc.)
- INSTALLATION.md → Installation Rust uniquement
- CONFIGURATION.md → Configuration Rust uniquement
- TESTING.md → Tests Rust uniquement
```
#### **sdk_relay**
```bash
# Fichiers à corriger complètement
- API.md → APIs réelles du service
- ARCHITECTURE.md → Architecture réelle du service
- USAGE.md → Utilisation réelle du service
- INSTALLATION.md → Installation réelle du service
- CONFIGURATION.md → Configuration réelle du service
```
#### **4NK_node**
```bash
# Fichiers à corriger complètement
- API.md → APIs réelles de l'infrastructure
- USAGE.md → Utilisation réelle de l'infrastructure
- ARCHITECTURE.md → Architecture réelle de l'infrastructure
- CONFIGURATION.md → Configuration réelle de l'infrastructure
```
### **Phase 3 : Création de Documentation Manquante (Priorité 3)**
#### **Projets sans Documentation Réelle**
```bash
# 4NK_template
- Créer une vraie documentation pour le template
# 4NK_wallet
- Créer une vraie documentation pour le wallet
# sdk_signer_client
- Créer une vraie documentation pour le client
# ihm_client
- Créer une vraie documentation pour l'interface
```
## 📋 Actions Spécifiques par Projet
### **1. sdk_client**
```bash
# Actions
- Supprimer 12 fichiers templates génériques
- Corriger 6 fichiers techniques pour refléter le stub WASM
- Garder uniquement la documentation pertinente
```
### **2. sdk_common**
```bash
# Actions
- Supprimer 12 fichiers templates génériques
- Corriger 6 fichiers techniques pour refléter l'état réel
- Garder uniquement la documentation pertinente
```
### **3. sdk_signer**
```bash
# Actions
- Supprimer 4 fichiers templates génériques
- Garder 4 fichiers corrects (docker-support.md, deployment.md, etc.)
```
### **4. sdk_storage**
```bash
# Actions
- Supprimer 10 fichiers templates génériques
- Garder 5 fichiers corrects (README.md, api_json_spec.md, etc.)
```
### **5. sdk_relay**
```bash
# Actions
- Supprimer 12 fichiers templates génériques
- Corriger 6 fichiers techniques pour refléter l'état réel
```
### **6. sdk_signer_client**
```bash
# Actions
- Supprimer 8 fichiers templates génériques
- Créer une vraie documentation pour le projet
```
### **7. 4NK_node**
```bash
# Actions
- Supprimer 12 fichiers templates génériques
- Corriger 6 fichiers techniques pour refléter l'état réel
```
### **8. 4NK_template**
```bash
# Actions
- Supprimer 8 fichiers templates génériques
- Créer une vraie documentation pour le template
```
### **9. 4NK_wallet**
```bash
# Actions
- Supprimer 8 fichiers templates génériques
- Créer une vraie documentation pour le wallet
```
### **10. ihm_client**
```bash
# Actions
- Supprimer 12 fichiers templates génériques
- Créer une vraie documentation pour l'interface
```
## 📊 Statistiques Finales
### **Avant Nettoyage**
- **Total fichiers** : 142 (hors INDEX.md)
- **Fichiers templates génériques** : ~100
- **Documentation incorrecte** : ~30
- **Documentation correcte** : ~12
### **Après Nettoyage**
- **Total fichiers** : ~50
- **Fichiers templates génériques** : 0 (supprimés)
- **Documentation incorrecte** : 0 (corrigée)
- **Documentation correcte** : ~50
### **Réduction** : ~65% de fichiers supprimés
## 🚀 Implémentation
### **Ordre d'exécution**
1. **Suppression des templates génériques** (100 fichiers)
2. **Correction des documentation incorrectes** (30 fichiers)
3. **Création de documentation manquante** (4 projets)
4. **Validation finale**
### **Validation**
- Vérifier que tous les liens fonctionnent
- S'assurer que la documentation reflète l'état actuel
- Tester la cohérence entre les projets
- Valider avec les développeurs
## 📝 Notes
- **Préserver** : Documentation technique correcte (sdk_storage, sdk_signer)
- **Supprimer** : Templates génériques, documentation obsolète
- **Corriger** : Documentation avec références incorrectes
- **Créer** : Documentation manquante pour les projets sans documentation
## 🎯 Objectif Final
**Documentation propre, cohérente et maintenable** avec :
- ✅ **0 fichier template générique**
- ✅ **0 documentation incorrecte**
- ✅ **100% de liens fonctionnels**
- ✅ **Documentation personnalisée pour chaque projet**
- ✅ **Réduction de 65% du volume de fichiers**
- ✅ **Documentation qui reflète l'état réel des projets**

View File

@ -1,173 +0,0 @@
# Plan de Nettoyage de la Documentation
## 📋 Analyse des Problèmes Identifiés
### 🔴 Problèmes Critiques
#### 1. **sdk_common/docs/**
- **API.md** : Contient des APIs Bitcoin Core et Blindbit qui ne sont pas liées à sdk_common
- **USAGE.md** : Références à des features WASM et npm qui n'existent pas
- **INDEX.md** : Références à des fichiers qui n'existent pas (QUICK_REFERENCE.md, MIGRATION.md)
#### 2. **sdk_client/docs/**
- **MIGRATION.md** : Fait référence à 4NK_node au lieu de sdk_client
- **INDEX.md** : Références à des fichiers inexistants
- **API.md** : Probablement obsolète avec le stub WASM actuel
#### 3. **sdk_signer/docs/**
- **INDEX.md** : Template générique non personnalisé
- **docker-support.md** : Documentation correcte mais pourrait être améliorée
#### 4. **sdk_storage/docs/**
- **README.md** : Documentation correcte mais fragmentée
- **api_json_spec.md** : Documentation technique correcte
## 🎯 Plan de Nettoyage
### Phase 1 : Nettoyage Critique (Priorité 1)
#### sdk_common/docs/
```bash
# Fichiers à corriger
- API.md → Supprimer ou corriger pour sdk_common uniquement
- USAGE.md → Corriger les références WASM/npm inexistantes
- INDEX.md → Mettre à jour les liens vers les fichiers existants
- ARCHITECTURE.md → Vérifier la cohérence avec l'état actuel
```
#### sdk_client/docs/
```bash
# Fichiers à corriger
- MIGRATION.md → Supprimer ou corriger pour sdk_client
- INDEX.md → Mettre à jour les liens
- API.md → Adapter pour le stub WASM actuel
```
### Phase 2 : Amélioration (Priorité 2)
#### sdk_signer/docs/
```bash
# Fichiers à améliorer
- INDEX.md → Personnaliser pour sdk_signer
- docker-support.md → Intégrer dans INDEX.md
- Créer une documentation complète
```
#### sdk_storage/docs/
```bash
# Fichiers à consolider
- README.md → Garder, bien structuré
- api_json_spec.md → Garder, documentation technique correcte
- Consolider les autres fichiers fragmentés
```
## 🔧 Actions Spécifiques
### 1. sdk_common/docs/
#### Supprimer/Corriger API.md
```markdown
# Remplacer par une vraie API de sdk_common
- Types et structures
- Fonctions utilitaires
- Exemples d'utilisation
- Pas d'APIs Bitcoin Core
```
#### Corriger USAGE.md
```markdown
# Supprimer les références inexistantes
- Supprimer "npm install @4nk/sdk-common"
- Supprimer les features WASM inexistantes
- Garder uniquement l'utilisation Rust
```
#### Mettre à jour INDEX.md
```markdown
# Corriger les liens
- Supprimer les références vers QUICK_REFERENCE.md
- Supprimer les références vers MIGRATION.md
- Garder uniquement les fichiers existants
```
### 2. sdk_client/docs/
#### Supprimer MIGRATION.md
```bash
# Ce fichier fait référence à 4NK_node
# Supprimer ou corriger complètement
```
#### Corriger INDEX.md
```markdown
# Mettre à jour pour refléter l'état actuel
- Stub WASM temporaire
- Migration flate2 en cours
- Pas de compilation WASM complète
```
### 3. sdk_signer/docs/
#### Personnaliser INDEX.md
```markdown
# Créer une vraie documentation sdk_signer
- Services fournis
- Compatibilité WASM
- Configuration TypeScript
- Tests et développement
```
### 4. sdk_storage/docs/
#### Consolider la documentation
```markdown
# Garder la structure actuelle
- README.md est correct
- api_json_spec.md est correct
- Consolider les fichiers fragmentés
```
## 📊 État Final Cible
### Documentation Propre et Cohérente
#### sdk_common/docs/
- ✅ API.md : APIs réelles de sdk_common uniquement
- ✅ USAGE.md : Utilisation Rust uniquement
- ✅ INDEX.md : Liens corrects vers fichiers existants
- ✅ ARCHITECTURE.md : Cohérent avec l'état actuel
#### sdk_client/docs/
- ✅ MIGRATION.md : Supprimé ou corrigé
- ✅ INDEX.md : Reflète l'état du stub WASM
- ✅ API.md : Documentation du stub WASM
#### sdk_signer/docs/
- ✅ INDEX.md : Documentation personnalisée complète
- ✅ docker-support.md : Intégré dans la documentation principale
#### sdk_storage/docs/
- ✅ README.md : Gardé tel quel (correct)
- ✅ api_json_spec.md : Gardé tel quel (correct)
- ✅ Autres fichiers : Consolidés si nécessaire
## 🚀 Implémentation
### Ordre d'exécution
1. **sdk_common/docs/** - Nettoyage critique
2. **sdk_client/docs/** - Nettoyage critique
3. **sdk_signer/docs/** - Amélioration
4. **sdk_storage/docs/** - Consolidation
### Validation
- Vérifier que tous les liens fonctionnent
- S'assurer que la documentation reflète l'état actuel
- Tester la cohérence entre les projets
- Valider avec les développeurs
## 📝 Notes
- **Préserver** : Documentation technique correcte (api_json_spec.md, docker-support.md)
- **Corriger** : Documentation avec références incorrectes
- **Supprimer** : Documentation obsolète ou incorrecte
- **Créer** : Documentation manquante pour sdk_signer

127
docs/etat_services.md Normal file
View File

@ -0,0 +1,127 @@
# État des Services 4NK Node
**Date :** 3 septembre 2025
**Heure :** 18:10 UTC
**Environnement :** Docker Compose sur Debian
## Résumé Global
- **Services fonctionnels :** 4/7 (57%) ⬆️
- **Services en erreur :** 3/7 (43%) ⬇️
- **Services redémarrant :** 0/7 (0%) ✅
## Détail des Services
### ✅ Services Fonctionnels
#### 1. **4nk-bitcoin** (bitcoin)
- **Statut :** `Up About a minute`
- **Ports :** 29000, 18443, 38332-38333
- **État :** ✅ **FONCTIONNEL - RPC corrigé**
- **Notes :** Credentials RPC ajoutés, réseau Docker autorisé (192.168.240.0/20)
#### 2. **4nk-tor** (tor)
- **Statut :** `Up 2 hours`
- **Ports :** 9050-9051
- **État :** ✅ **FONCTIONNEL**
- **Notes :** Service Tor opérationnel, listeners SOCKS et Control actifs
#### 3. **4nk-blindbit** (blindbit) ⭐ **CORRIGÉ**
- **Statut :** `Up 31 seconds (health: starting)`
- **Ports :** 8000
- **État :** ✅ **FONCTIONNEL - RPC authentifié**
- **Notes :** Connexion RPC réussie, synchronisation active, service HTTP opérationnel
#### 4. **4nk-sdk-storage** (sdk_storage)
- **Statut :** `Up 2 hours (unhealthy)`
- **Ports :** 8081
- **État :** ✅ **FONCTIONNEL mais non vérifié**
- **Notes :** Service démarré mais health check échoue
### ❌ Services en Erreur
#### 5. **4nk-sdk-signer** (sdk_signer)
- **Statut :** `Arrêté`
- **Erreur :** `SyntaxError: Unexpected token 'export'`
- **Cause :** Incompatibilité ES modules vs CommonJS
- **Fichier problématique :** `/app/pkg/sdk_client.js`
- **Détail :** Le code WASM généré utilise la syntaxe ES6 `export` mais Node.js s'attend à du CommonJS
#### 6. **4nk-sdk-relay** (sdk_relay)
- **Statut :** `Arrêté`
- **Erreur :** `Failed to find conf file`
- **Cause :** Fichier de configuration manquant
- **Impact :** Service critique pour la communication entre composants
#### 7. **4nk-ihm-client** (ihm_client)
- **Statut :** `Up 2 hours (unhealthy)`
- **Ports :** 3003, 8080
- **État :** ✅ **Démarré mais non vérifié**
- **Notes :** Interface utilisateur accessible mais health check échoue
## Problèmes Résolus ✅
### **Authentification RPC Bitcoin-BlindBit (RÉSOLU)**
- **Problème :** BlindBit recevait des erreurs 403 Forbidden
- **Cause :** Configuration réseau incorrecte (`rpcallowip=172.24.0.0/16` au lieu de `192.168.240.0/20`)
- **Solution :**
1. Ajout des credentials RPC (`rpcuser=bitcoin`, `rpcpassword=bitcoin`)
2. Correction du réseau autorisé (`rpcallowip=192.168.240.0/20`)
3. Redémarrage de Bitcoin pour appliquer la configuration
- **Résultat :** BlindBit se connecte maintenant avec succès à Bitcoin
## Problèmes Identifiés
### 1. **Incompatibilité ES Modules (CRITIQUE)**
- **Service :** sdk_signer
- **Problème :** Le code WASM généré par `wasm-pack` utilise la syntaxe ES6
- **Solution :** Configurer le projet pour utiliser ES modules ou convertir en CommonJS
### 2. **Configuration Manquante (CRITIQUE)**
- **Service :** sdk_relay
- **Problème :** Fichier de configuration introuvable
- **Solution :** Vérifier la présence et la validité des fichiers de config
### 3. **Health Checks (FAIBLE)**
- **Services :** sdk_storage, ihm_client
- **Problème :** Health checks échouent malgré un fonctionnement apparent
- **Solution :** Ajuster les critères de health check
## Recommandations
### Priorité 1 : Corriger sdk_signer ✅
- **Statut :** En attente
- **Action :** Résoudre l'incompatibilité ES modules
### Priorité 2 : Corriger sdk_relay ✅
- **Statut :** En attente
- **Action :** Identifier et corriger le fichier de configuration manquant
### Priorité 3 : Améliorer les health checks ✅
- **Statut :** En attente
- **Action :** Ajuster les critères de vérification
## Actions Effectuées
1. ✅ **Ajouté les credentials RPC** dans `conf/bitcoin.conf`
2. ✅ **Corrigé la configuration réseau** (`rpcallowip=192.168.240.0/20`)
3. ✅ **Redémarré Bitcoin** pour appliquer la configuration
4. ✅ **Testé la connexion RPC** avec succès
5. ✅ **Relancé BlindBit** avec succès
6. ✅ **Vérifié le fonctionnement** du service
## Impact sur l'Architecture
- **Communication inter-services :** ✅ BlindBit-Bitcoin fonctionne
- **Signature des transactions :** ❌ Impossible (sdk_signer défaillant)
- **Confidentialité :** ✅ **Disponible (blindbit fonctionnel)**
- **Interface utilisateur :** Partiellement fonctionnelle
- **Stockage :** Fonctionnel mais non vérifié
## Prochaines Étapes
1. ✅ **BlindBit corrigé** - Service opérationnel
2. 🔄 **Corriger sdk_signer** - Résoudre l'incompatibilité ES modules
3. 🔄 **Corriger sdk_relay** - Résoudre la configuration manquante
4. 🔄 **Améliorer les health checks** - Optimiser la surveillance des services
5. 🔄 **Tester l'intégration complète** - Vérifier la communication inter-services

View File

@ -1,115 +0,0 @@
# Modules Docker (4NK_dev)
## 4NK_node
Infrastructure Docker complète pour l'écosystème 4NK avec Bitcoin, Tor, et services 4NK.
### Services inclus
- **bitcoin-signet** : Nœud Bitcoin testnet
- **tor-proxy** : Proxy Tor pour l'anonymat
- **blindbit-oracle** : Oracle pour les transactions confidentielles
- **sdk-storage** : Service de stockage distribué
- **sdk_relay_1/2/3** : Services de relais P2P
- **4nk-ihm-client** : Interface utilisateur web
- **4nk-reverse-proxy** : Proxy inverse pour les services
### Scripts de gestion
- `4NK_node/scripts/manage_services.sh` : Script principal de gestion
- `start` : Démarre tous les services
- `stop` : Arrête tous les services
- `clean` : Nettoie conteneurs, images, volumes
- `restart` : Redémarre tous les services
- `status` : Affiche le statut des services
- `logs` : Affiche les logs des services
### Scripts legacy (modules/)
- `modules/4NK_node/build.sh` : construit les services avec `docker compose build`
- `modules/4NK_node/up.sh` : démarre les services en détaché
- `modules/4NK_node/down.sh` : arrête et nettoie les services
- `modules/4NK_node/logs.sh` : affiche les logs (suivi)
- `modules/4NK_node/clean.sh` : down -v + prune d'images
### Version/tag
Lit `4NK_node/VERSION` si présent, sinon utilise `git describe` pour définir `COMPOSE_PROJECT_NAME`.
## 4NK_template
Template Docker multi-stage Node.js pour les nouveaux projets 4NK.
### Dockerfile
- Multi-stage build optimisé
- Support pour Node.js et Rust
- Configuration automatique des hooks Git
### Scripts
- `modules/4NK_template/build.sh` : build de l'image à partir de `4NK_template/`
- `modules/4NK_template/run.sh` : exécute l'image, mappe le port 3000
- `modules/4NK_template/clean.sh` : supprime l'image construite et fait un prune
### Version/tag
Lit `4NK_template/VERSION` si présent, sinon `git describe`.
## Prérequis
- Docker et Docker Compose v2 (plugin) installés
- Rust (latest stable) pour les projets SDK
- Node.js 18+ pour les clients
## Utilisation (recommandée)
### Gestion moderne avec manage_services.sh
```bash
# Démarrer l'infrastructure complète
cd 4NK_node
./scripts/manage_services.sh start
# Vérifier le statut
./scripts/manage_services.sh status
# Arrêter et nettoyer
./scripts/manage_services.sh clean
```
### Utilisation séquentielle (legacy)
1. Construire 4NK_node
- `bash modules/4NK_node/build.sh`
2. Démarrer 4NK_node
- `bash modules/4NK_node/up.sh`
3. Construire 4NK_template
- `bash modules/4NK_template/build.sh`
4. Lancer 4NK_template
- `bash modules/4NK_template/run.sh`
5. Logs 4NK_node
- `bash modules/4NK_node/logs.sh`
6. Arrêt 4NK_node
- `bash modules/4NK_node/down.sh`
## Configuration
### Variables d'environnement
- `COMPOSE_PROJECT_NAME` : Nom du projet Docker (auto-détecté)
- `DOCKER_BUILDKIT` : Active BuildKit pour des builds plus rapides
### Ports exposés
- **9050-9051** : Tor proxy
- **18443** : Bitcoin RPC
- **29000** : Bitcoin P2P
- **8000** : Blindbit oracle
- **8081** : SDK Storage
- **8090-8091** : SDK Relays
## Troubleshooting
### Problèmes courants
1. **Ports déjà utilisés** : Vérifier avec `netstat -tulpn | grep <port>`
2. **Images corrompues** : Utiliser `./scripts/manage_services.sh clean`
3. **Services qui ne démarrent pas** : Vérifier les logs avec `./scripts/manage_services.sh logs`
### Logs et debugging
```bash
# Logs de tous les services
./scripts/manage_services.sh logs
# Logs d'un service spécifique
docker compose logs <service-name>
# Shell dans un conteneur
docker compose exec <service-name> /bin/bash
```

1
id_verif Submodule

@ -0,0 +1 @@
Subproject commit 9e2d56383b1ddea92149f2e201cad630d5e57b30

View File

@ -1,11 +1,16 @@
name,url,type,target,directory
sdk_storage,https://git.4nkweb.com/4nk/sdk_storage.git,branch,docker-support,sdk_storage
sdk_signer_client,https://git.4nkweb.com/4nk/sdk_signer_client.git,create_from,docker-support,sdk_signer_client
sdk_signer,https://git.4nkweb.com/4nk/sdk_signer.git,branch,docker-support,sdk_signer
ihm_client,https://git.4nkweb.com/4nk/ihm_client.git,branch,docker-support,ihm_client
sdk_relay,https://git.4nkweb.com/4nk/sdk_relay.git,branch,docker-support,sdk_relay
sdk_common,https://git.4nkweb.com/4nk/sdk_common.git,branch,docker-support,sdk_common
4NK_wallet,https://git.4nkweb.com/4nk/4NK_wallet.git,create_from,docker-support,4NK_wallet
sdk_client,https://git.4nkweb.com/4nk/sdk_client.git,branch,docker-support,sdk_client
4NK_template,https://git.4nkweb.com/4nk/4NK_template.git,branch,main,4NK_template
4NK_node,git@git.4nkweb.com:4nk/4NK_node.git,branch,main,4NK_node
name,url,types,branch,directory
tor,https://github.com/torproject/tor.git,clone|pull&push,master,tor
bitcoin-core,https://github.com/bitcoin/bitcoin.git,clone|pull&push,master,bitcoin-core
blindbit-oracle,https://github.com/setavenger/blindbit-oracle.git,clone|pull&push,master,blindbit-oracle
sp-client,https://github.com/Sosthene00/sp-client.git,clone|pull&push,dev,sp-client
sdk_common,https://git.4nkweb.com/4nk/sdk_common.git,clone|pull&push,docker-support-v2,sdk_common
sdk_client,https://git.4nkweb.com/4nk/sdk_client.git,clone|pull&push,docker-support-v2,sdk_client
sdk_signer_client,https://git.4nkweb.com/4nk/sdk_signer_client.git,clone|pull&push,docker-support-v2,sdk_signer_client
sdk_relay,https://git.4nkweb.com/4nk/sdk_relay.git,clone|pull&push,docker-support-v2,sdk_relay
sdk_storage,https://git.4nkweb.com/4nk/sdk_storage.git,clone|pull&push,docker-support-v2,sdk_storage
sdk_signer,https://git.4nkweb.com/4nk/sdk_signer.git,clone|pull&push,docker-support-v2,sdk_signer
ihm_client,https://git.4nkweb.com/4nk/ihm_client.git,clone|pull&push,docker-support-v2,ihm_client
4NK_template,https://git.4nkweb.com/4nk/4NK_template.git,clone|pull&push,docker-support-v2,4NK_template
4NK_node,git@git.4nkweb.com:4nk/4NK_node.git,clone|pull&push,docker-support-v2,4NK_node
4NK_wallet,https://git.4nkweb.com/4nk/4NK_wallet.git,clone|pull&push,docker-support-v2,4NK_wallet
id_verif,git@git.4nkweb.com:4nk/id_verif.git,clone|pull&push,docker-support-v2,id_verif

1 name url type types target branch directory
2 sdk_storage tor https://git.4nkweb.com/4nk/sdk_storage.git https://github.com/torproject/tor.git branch clone|pull&push docker-support master sdk_storage tor
3 sdk_signer_client bitcoin-core https://git.4nkweb.com/4nk/sdk_signer_client.git https://github.com/bitcoin/bitcoin.git create_from clone|pull&push docker-support master sdk_signer_client bitcoin-core
4 sdk_signer blindbit-oracle https://git.4nkweb.com/4nk/sdk_signer.git https://github.com/setavenger/blindbit-oracle.git branch clone|pull&push docker-support master sdk_signer blindbit-oracle
5 ihm_client sp-client https://git.4nkweb.com/4nk/ihm_client.git https://github.com/Sosthene00/sp-client.git branch clone|pull&push docker-support dev ihm_client sp-client
6 sdk_relay sdk_common https://git.4nkweb.com/4nk/sdk_relay.git https://git.4nkweb.com/4nk/sdk_common.git branch clone|pull&push docker-support docker-support-v2 sdk_relay sdk_common
7 sdk_common sdk_client https://git.4nkweb.com/4nk/sdk_common.git https://git.4nkweb.com/4nk/sdk_client.git branch clone|pull&push docker-support docker-support-v2 sdk_common sdk_client
8 4NK_wallet sdk_signer_client https://git.4nkweb.com/4nk/4NK_wallet.git https://git.4nkweb.com/4nk/sdk_signer_client.git create_from clone|pull&push docker-support docker-support-v2 4NK_wallet sdk_signer_client
9 sdk_client sdk_relay https://git.4nkweb.com/4nk/sdk_client.git https://git.4nkweb.com/4nk/sdk_relay.git branch clone|pull&push docker-support docker-support-v2 sdk_client sdk_relay
10 4NK_template sdk_storage https://git.4nkweb.com/4nk/4NK_template.git https://git.4nkweb.com/4nk/sdk_storage.git branch clone|pull&push main docker-support-v2 4NK_template sdk_storage
11 4NK_node sdk_signer git@git.4nkweb.com:4nk/4NK_node.git https://git.4nkweb.com/4nk/sdk_signer.git branch clone|pull&push main docker-support-v2 4NK_node sdk_signer
12 ihm_client https://git.4nkweb.com/4nk/ihm_client.git clone|pull&push docker-support-v2 ihm_client
13 4NK_template https://git.4nkweb.com/4nk/4NK_template.git clone|pull&push docker-support-v2 4NK_template
14 4NK_node git@git.4nkweb.com:4nk/4NK_node.git clone|pull&push docker-support-v2 4NK_node
15 4NK_wallet https://git.4nkweb.com/4nk/4NK_wallet.git clone|pull&push docker-support-v2 4NK_wallet
16 id_verif git@git.4nkweb.com:4nk/id_verif.git clone|pull&push docker-support-v2 id_verif