diff --git a/.gitignore b/.gitignore index 52c9f92..3828707 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ sdk_relay/ sdk_signer/ sdk_signer_client/ sdk_storage/ +blindbit-oracle/ +sp-client/ diff --git a/README.md b/README.md index e852eb4..d0df8b6 100644 --- a/README.md +++ b/README.md @@ -112,3 +112,5 @@ cd 4NK_node && ./scripts/manage_services.sh stop ## 📄 Licence MIT License - voir les fichiers LICENSE individuels dans chaque projet. + + diff --git a/docs/documentation_cleanup_complete_analysis.md b/docs/documentation_cleanup_complete_analysis.md deleted file mode 100644 index a21a745..0000000 --- a/docs/documentation_cleanup_complete_analysis.md +++ /dev/null @@ -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** diff --git a/docs/documentation_cleanup_final_analysis.md b/docs/documentation_cleanup_final_analysis.md deleted file mode 100644 index 51b044c..0000000 --- a/docs/documentation_cleanup_final_analysis.md +++ /dev/null @@ -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** diff --git a/docs/documentation_cleanup_plan.md b/docs/documentation_cleanup_plan.md deleted file mode 100644 index b73c7b3..0000000 --- a/docs/documentation_cleanup_plan.md +++ /dev/null @@ -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 diff --git a/docs/etat_services.md b/docs/etat_services.md new file mode 100644 index 0000000..05715e1 --- /dev/null +++ b/docs/etat_services.md @@ -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 diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index 223e4f8..0000000 --- a/docs/modules.md +++ /dev/null @@ -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 ` -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 - -# Shell dans un conteneur -docker compose exec /bin/bash -``` diff --git a/id_verif b/id_verif new file mode 160000 index 0000000..9e2d563 --- /dev/null +++ b/id_verif @@ -0,0 +1 @@ +Subproject commit 9e2d56383b1ddea92149f2e201cad630d5e57b30 diff --git a/repos.csv b/repos.csv index fc8d29b..9573c27 100644 --- a/repos.csv +++ b/repos.csv @@ -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