Compare commits
No commits in common. "docker-support-local-20250826-052353" and "main" have entirely different histories.
docker-sup
...
main
@ -1,11 +0,0 @@
|
||||
# Ignorer les sorties volumineuses ou non pertinentes pour le contexte IA
|
||||
archive/**
|
||||
tests/logs/**
|
||||
tests/reports/**
|
||||
node_modules/**
|
||||
dist/**
|
||||
build/**
|
||||
.tmp/**
|
||||
.cache/**#
|
||||
.env
|
||||
.env.*
|
||||
@ -1,59 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Fondations de rédaction et de comportement
|
||||
|
||||
[portée]
|
||||
S’applique à tout le dépôt 4NK/4NK_node pour toute génération, refactorisation, édition inline ou discussion dans Cursor.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir l’usage exclusif du français.
|
||||
- Proscrire l’injection d’exemples de code applicatif dans la base de code.
|
||||
- Assurer une cohérence stricte de terminologie et de ton.
|
||||
- Exiger une introduction et/ou une conclusion dans toute proposition de texte.
|
||||
|
||||
[directives]
|
||||
|
||||
- Toujours répondre et documenter en français.
|
||||
- Ne pas inclure d’exemples exécutables ou de quickstarts dans la base ; préférer des descriptions prescriptives.
|
||||
- Tout contenu produit doit mentionner explicitement les artefacts à mettre à jour lorsqu’il impacte docs/ et tests/.
|
||||
- Préserver la typographie française (capitaliser uniquement le premier mot d’un titre et les noms propres).
|
||||
|
||||
[validations]
|
||||
|
||||
- Relecture linguistique et technique systématique.
|
||||
- Refuser toute sortie avec exemples de code applicatif.
|
||||
- Vérifier que l’issue traitée se conclut par un rappel des fichiers à mettre à jour.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- README.md, docs/**, tests/**, CHANGELOG.md, .gitea/**.# Fondations de rédaction et de comportement
|
||||
|
||||
[portée]
|
||||
S’applique à tout le dépôt 4NK/4NK_node pour toute génération, refactorisation, édition inline ou discussion dans Cursor.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir l’usage exclusif du français.
|
||||
- Proscrire l’injection d’exemples de code applicatif dans la base de code.
|
||||
- Assurer une cohérence stricte de terminologie et de ton.
|
||||
- Exiger une introduction et/ou une conclusion dans toute proposition de texte.
|
||||
|
||||
[directives]
|
||||
|
||||
- Toujours répondre et documenter en français.
|
||||
- Ne pas inclure d’exemples exécutables ou de quickstarts dans la base ; préférer des descriptions prescriptives.
|
||||
- Tout contenu produit doit mentionner explicitement les artefacts à mettre à jour lorsqu’il impacte docs/ et tests/.
|
||||
- Préserver la typographie française (capitaliser uniquement le premier mot d’un titre et les noms propres).
|
||||
|
||||
[validations]
|
||||
|
||||
- Relecture linguistique et technique systématique.
|
||||
- Refuser toute sortie avec exemples de code applicatif.
|
||||
- Vérifier que l’issue traitée se conclut par un rappel des fichiers à mettre à jour.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- README.md, docs/**, tests/**, CHANGELOG.md, .gitea/**.
|
||||
@ -1,139 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Structure projet 4NK_node
|
||||
|
||||
[portée]
|
||||
Maintenance de l’arborescence canonique, création/mise à jour/suppression de fichiers et répertoires.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir l’alignement strict avec l’arborescence 4NK_node.
|
||||
- Prévenir toute dérive structurelle.
|
||||
|
||||
[directives]
|
||||
|
||||
- S’assurer que l’arborescence suivante existe et reste conforme :
|
||||
|
||||
4NK/4NK_node
|
||||
├── archive
|
||||
├── CHANGELOG.md
|
||||
├── CODE_OF_CONDUCT.md
|
||||
├── CONTRIBUTING.md
|
||||
├── docker-compose.yml
|
||||
├── docs
|
||||
│ ├── API.md
|
||||
│ ├── ARCHITECTURE.md
|
||||
│ ├── COMMUNITY_GUIDE.md
|
||||
│ ├── CONFIGURATION.md
|
||||
│ ├── GITEA_SETUP.md
|
||||
│ ├── INDEX.md
|
||||
│ ├── INSTALLATION.md
|
||||
│ ├── MIGRATION.md
|
||||
│ ├── OPEN_SOURCE_CHECKLIST.md
|
||||
│ ├── QUICK_REFERENCE.md
|
||||
│ ├── RELEASE_PLAN.md
|
||||
│ ├── ROADMAP.md
|
||||
│ ├── SECURITY_AUDIT.md
|
||||
│ ├── TESTING.md
|
||||
│ └── USAGE.md
|
||||
├── LICENSE
|
||||
├── README.md
|
||||
├── tests
|
||||
│ ├── cleanup.sh
|
||||
│ ├── connectivity
|
||||
│ ├── external
|
||||
│ ├── integration
|
||||
│ ├── logs
|
||||
│ ├── performance
|
||||
│ ├── README.md
|
||||
│ ├── reports
|
||||
│ └── unit
|
||||
└── .gitea
|
||||
├── ISSUE_TEMPLATE
|
||||
│ ├── bug_report.md
|
||||
│ └── feature_request.md
|
||||
├── PULL_REQUEST_TEMPLATE.md
|
||||
└── workflows
|
||||
└── ci.yml
|
||||
|
||||
- Tout document obsolète est déplacé vers archive/ avec métadonnées (date, raison).
|
||||
- Interdire la suppression brute de fichiers sans archivage et note dans CHANGELOG.md.
|
||||
|
||||
[validations]
|
||||
|
||||
- Diff structurel comparé à cette référence.
|
||||
- Erreur bloquante si un fichier « requis » manque.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- archive/**, docs/**, tests/**, .gitea/**, CHANGELOG.md.
|
||||
|
||||
# Structure projet 4NK_node
|
||||
|
||||
[portée]
|
||||
Maintenance de l’arborescence canonique, création/mise à jour/suppression de fichiers et répertoires.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir l’alignement strict avec l’arborescence 4NK_node.
|
||||
- Prévenir toute dérive structurelle.
|
||||
|
||||
[directives]
|
||||
|
||||
- S’assurer que l’arborescence suivante existe et reste conforme :
|
||||
|
||||
4NK/4NK_node
|
||||
├── archive
|
||||
├── CHANGELOG.md
|
||||
├── CODE_OF_CONDUCT.md
|
||||
├── CONTRIBUTING.md
|
||||
├── docker-compose.yml
|
||||
├── docs
|
||||
│ ├── API.md
|
||||
│ ├── ARCHITECTURE.md
|
||||
│ ├── COMMUNITY_GUIDE.md
|
||||
│ ├── CONFIGURATION.md
|
||||
│ ├── GITEA_SETUP.md
|
||||
│ ├── INDEX.md
|
||||
│ ├── INSTALLATION.md
|
||||
│ ├── MIGRATION.md
|
||||
│ ├── OPEN_SOURCE_CHECKLIST.md
|
||||
│ ├── QUICK_REFERENCE.md
|
||||
│ ├── RELEASE_PLAN.md
|
||||
│ ├── ROADMAP.md
|
||||
│ ├── SECURITY_AUDIT.md
|
||||
│ ├── TESTING.md
|
||||
│ └── USAGE.md
|
||||
├── LICENSE
|
||||
├── README.md
|
||||
├── tests
|
||||
│ ├── cleanup.sh
|
||||
│ ├── connectivity
|
||||
│ ├── external
|
||||
│ ├── integration
|
||||
│ ├── logs
|
||||
│ ├── performance
|
||||
│ ├── README.md
|
||||
│ ├── reports
|
||||
│ └── unit
|
||||
└── .gitea
|
||||
├── ISSUE_TEMPLATE
|
||||
│ ├── bug_report.md
|
||||
│ └── feature_request.md
|
||||
├── PULL_REQUEST_TEMPLATE.md
|
||||
└── workflows
|
||||
└── ci.yml
|
||||
|
||||
- Tout document obsolète est déplacé vers archive/ avec métadonnées (date, raison).
|
||||
- Interdire la suppression brute de fichiers sans archivage et note dans CHANGELOG.md.
|
||||
|
||||
[validations]
|
||||
|
||||
- Diff structurel comparé à cette référence.
|
||||
- Erreur bloquante si un fichier « requis » manque.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- archive/**, docs/**, tests/**, .gitea/**, CHANGELOG.md.
|
||||
@ -1,62 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Documentation continue
|
||||
|
||||
[portée]
|
||||
Mises à jour de docs/** corrélées à tout changement de code, configuration, dépendance, données ou CI.
|
||||
|
||||
[objectifs]
|
||||
- Remplacer toute section générique « RESUME » par des mises à jour ciblées dans les fichiers appropriés.
|
||||
- Tenir INDEX.md comme table des matières de référence.
|
||||
|
||||
[directives]
|
||||
- À chaque changement, mettre à jour :
|
||||
- API.md (spécifications, contrats, schémas, invariants).
|
||||
- ARCHITECTURE.md (décisions, diagrammes, couplages, performances).
|
||||
- CONFIGURATION.md (paramètres, formats, valeurs par défaut).
|
||||
- INSTALLATION.md (pré-requis, étapes, vérifications).
|
||||
- MIGRATION.md (chemins de migration, scripts, compatibilités).
|
||||
- USAGE.md (parcours fonctionnels, contraintes).
|
||||
- TESTING.md (pyramide, critères d’acceptation).
|
||||
- SECURITY_AUDIT.md (menaces, contrôles, dettes résiduelles).
|
||||
- RELEASE_PLAN.md, ROADMAP.md (planification), OPEN_SOURCE_CHECKLIST.md, COMMUNITY_GUIDE.md, GITEA_SETUP.md.
|
||||
- Maintenir QUICK_REFERENCE.md pour les référentiels synthétiques utilisés par l’équipe.
|
||||
- Ajouter un REX technique en cas d’hypothèses multiples avant résolution dans archive/.
|
||||
|
||||
[validations]
|
||||
- Cohérence croisée entre README.md et INDEX.md.
|
||||
- Refus si une modification de code n’a pas de trace dans docs/** correspondants.
|
||||
|
||||
[artefacts concernés]
|
||||
- docs/**, README.md, archive/**.
|
||||
# Documentation continue
|
||||
|
||||
[portée]
|
||||
Mises à jour de docs/** corrélées à tout changement de code, configuration, dépendance, données ou CI.
|
||||
|
||||
[objectifs]
|
||||
- Remplacer toute section générique « RESUME » par des mises à jour ciblées dans les fichiers appropriés.
|
||||
- Tenir INDEX.md comme table des matières de référence.
|
||||
|
||||
[directives]
|
||||
- À chaque changement, mettre à jour :
|
||||
- API.md (spécifications, contrats, schémas, invariants).
|
||||
- ARCHITECTURE.md (décisions, diagrammes, couplages, performances).
|
||||
- CONFIGURATION.md (paramètres, formats, valeurs par défaut).
|
||||
- INSTALLATION.md (pré-requis, étapes, vérifications).
|
||||
- MIGRATION.md (chemins de migration, scripts, compatibilités).
|
||||
- USAGE.md (parcours fonctionnels, contraintes).
|
||||
- TESTING.md (pyramide, critères d’acceptation).
|
||||
- SECURITY_AUDIT.md (menaces, contrôles, dettes résiduelles).
|
||||
- RELEASE_PLAN.md, ROADMAP.md (planification), OPEN_SOURCE_CHECKLIST.md, COMMUNITY_GUIDE.md, GITEA_SETUP.md.
|
||||
- Maintenir QUICK_REFERENCE.md pour les référentiels synthétiques utilisés par l’équipe.
|
||||
- Ajouter un REX technique en cas d’hypothèses multiples avant résolution dans archive/.
|
||||
|
||||
[validations]
|
||||
- Cohérence croisée entre README.md et INDEX.md.
|
||||
- Refus si une modification de code n’a pas de trace dans docs/** correspondants.
|
||||
|
||||
[artefacts concernés]
|
||||
- docs/**, README.md, archive/**.
|
||||
@ -1,57 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Tests et qualité
|
||||
|
||||
[portée]
|
||||
Stratégie de tests, exécution locale, stabilité, non-régression.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Exiger des tests verts avant tout commit.
|
||||
- Couvrir les axes unit, integration, connectivity, performance, external.
|
||||
|
||||
[directives]
|
||||
|
||||
- Ajouter/mettre à jour des tests dans tests/unit, tests/integration, tests/connectivity, tests/performance, tests/external selon l’impact.
|
||||
- Consigner les journaux dans tests/logs et les rapports dans tests/reports.
|
||||
- Maintenir tests/README.md (stratégie, outillage, seuils).
|
||||
- Fournir un nettoyage reproductible via tests/cleanup.sh.
|
||||
- Bloquer l’édition si des tests échouent tant que la correction n’est pas appliquée.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus d’un commit si tests en échec.
|
||||
- Exiger justification et plan de test dans docs/TESTING.md pour toute refonte majeure.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- tests/**, docs/TESTING.md, CHANGELOG.md.
|
||||
|
||||
# Tests et qualité
|
||||
|
||||
[portée]
|
||||
Stratégie de tests, exécution locale, stabilité, non-régression.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Exiger des tests verts avant tout commit.
|
||||
- Couvrir les axes unit, integration, connectivity, performance, external.
|
||||
|
||||
[directives]
|
||||
|
||||
- Ajouter/mettre à jour des tests dans tests/unit, tests/integration, tests/connectivity, tests/performance, tests/external selon l’impact.
|
||||
- Consigner les journaux dans tests/logs et les rapports dans tests/reports.
|
||||
- Maintenir tests/README.md (stratégie, outillage, seuils).
|
||||
- Fournir un nettoyage reproductible via tests/cleanup.sh.
|
||||
- Bloquer l’édition si des tests échouent tant que la correction n’est pas appliquée.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus d’un commit si tests en échec.
|
||||
- Exiger justification et plan de test dans docs/TESTING.md pour toute refonte majeure.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- tests/**, docs/TESTING.md, CHANGELOG.md.
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Dépendances, compilation et build
|
||||
|
||||
[portée]
|
||||
Gestion des dépendances, compilation fréquente, politique de versions.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Ajouter automatiquement les dépendances manquantes si justifié.
|
||||
- Rechercher systématiquement les dernières versions stables.
|
||||
|
||||
[directives]
|
||||
|
||||
- Lorsqu’une fonctionnalité nécessite une dépendance, l’ajouter et la documenter (nom, version, portée, impact) dans docs/ARCHITECTURE.md et docs/CONFIGURATION.md si nécessaire.
|
||||
- Compiler très régulièrement et « quand nécessaire » (avant refactor, avant push, après mise à jour de dépendances).
|
||||
- Corriger toute erreur de compilation/exécution avant de poursuivre.
|
||||
- Documenter tout changement de dépendances (raison, risques, rollback).
|
||||
|
||||
[validations]
|
||||
|
||||
- Interdire la progression si la compilation échoue.
|
||||
- Vérifier la présence d’une note de changement dans CHANGELOG.md en cas de dépendance ajoutée/retirée.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/ARCHITECTURE.md, docs/CONFIGURATION.md, CHANGELOG.md.
|
||||
|
||||
# Dépendances, compilation et build
|
||||
|
||||
[portée]
|
||||
Gestion des dépendances, compilation fréquente, politique de versions.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Ajouter automatiquement les dépendances manquantes si justifié.
|
||||
- Rechercher systématiquement les dernières versions stables.
|
||||
|
||||
[directives]
|
||||
|
||||
- Lorsqu’une fonctionnalité nécessite une dépendance, l’ajouter et la documenter (nom, version, portée, impact) dans docs/ARCHITECTURE.md et docs/CONFIGURATION.md si nécessaire.
|
||||
- Compiler très régulièrement et « quand nécessaire » (avant refactor, avant push, après mise à jour de dépendances).
|
||||
- Corriger toute erreur de compilation/exécution avant de poursuivre.
|
||||
- Documenter tout changement de dépendances (raison, risques, rollback).
|
||||
|
||||
[validations]
|
||||
|
||||
- Interdire la progression si la compilation échoue.
|
||||
- Vérifier la présence d’une note de changement dans CHANGELOG.md en cas de dépendance ajoutée/retirée.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/ARCHITECTURE.md, docs/CONFIGURATION.md, CHANGELOG.md.
|
||||
@ -1,54 +0,0 @@
|
||||
---
|
||||
alwaysApply: false
|
||||
---
|
||||
# Modélisation des données à partir de CSV
|
||||
|
||||
[portée]
|
||||
Utilisation des CSV comme base des modèles de données, y compris en-têtes multi-lignes.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Confirmer la structure inférée pour chaque CSV.
|
||||
- Demander une définition formelle de toutes les colonnes.
|
||||
|
||||
[directives]
|
||||
|
||||
- Gérer explicitement les en-têtes multi-lignes (titre principal + sous-colonnes).
|
||||
- Confirmer par écrit dans docs/API.md ou docs/ARCHITECTURE.md : nombre de lignes d’en-tête, mapping colonnes→types, unités, domaines de valeurs, nullabilité, contraintes.
|
||||
- Poser des questions si ambiguïtés ; proposer une normalisation temporaire documentée.
|
||||
- Corriger automatiquement les incohérences de types si une règle de mapping est établie ailleurs et documenter la transformation.
|
||||
|
||||
[validations]
|
||||
|
||||
- Aucune ingestion sans spécification de colonnes validée.
|
||||
- Traçabilité des corrections de types (avant/après) dans docs/ARCHITECTURE.md.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/API.md, docs/ARCHITECTURE.md, docs/USAGE.md.
|
||||
|
||||
# Modélisation des données à partir de CSV
|
||||
|
||||
[portée]
|
||||
Utilisation des CSV comme base des modèles de données, y compris en-têtes multi-lignes.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Confirmer la structure inférée pour chaque CSV.
|
||||
- Demander une définition formelle de toutes les colonnes.
|
||||
|
||||
[directives]
|
||||
|
||||
- Gérer explicitement les en-têtes multi-lignes (titre principal + sous-colonnes).
|
||||
- Confirmer par écrit dans docs/API.md ou docs/ARCHITECTURE.md : nombre de lignes d’en-tête, mapping colonnes→types, unités, domaines de valeurs, nullabilité, contraintes.
|
||||
- Poser des questions si ambiguïtés ; proposer une normalisation temporaire documentée.
|
||||
- Corriger automatiquement les incohérences de types si une règle de mapping est établie ailleurs et documenter la transformation.
|
||||
|
||||
[validations]
|
||||
|
||||
- Aucune ingestion sans spécification de colonnes validée.
|
||||
- Traçabilité des corrections de types (avant/après) dans docs/ARCHITECTURE.md.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/API.md, docs/ARCHITECTURE.md, docs/USAGE.md.
|
||||
@ -1,41 +0,0 @@
|
||||
---
|
||||
alwaysApply: false
|
||||
---
|
||||
# Lecture des documents bureautiques
|
||||
|
||||
[portée]
|
||||
Lecture des fichiers .docx et alternatives.
|
||||
|
||||
[objectifs]
|
||||
- Utiliser docx2txt par défaut.
|
||||
- Proposer des solutions de repli si lecture impossible.
|
||||
|
||||
[directives]
|
||||
- Lire les .docx avec docx2txt.
|
||||
- En cas d’échec, proposer : conversion via pandoc, demande d’une source alternative, ou extraction textuelle.
|
||||
- Documenter dans docs/INDEX.md la provenance et le statut des documents importés.
|
||||
|
||||
[validations]
|
||||
- Vérification que les contenus extraits sont intégrés aux fichiers docs/ concernés.
|
||||
|
||||
[artefacts concernés]
|
||||
- docs/**, archive/**.
|
||||
# Lecture des documents bureautiques
|
||||
|
||||
[portée]
|
||||
Lecture des fichiers .docx et alternatives.
|
||||
|
||||
[objectifs]
|
||||
- Utiliser docx2txt par défaut.
|
||||
- Proposer des solutions de repli si lecture impossible.
|
||||
|
||||
[directives]
|
||||
- Lire les .docx avec docx2txt.
|
||||
- En cas d’échec, proposer : conversion via pandoc, demande d’une source alternative, ou extraction textuelle.
|
||||
- Documenter dans docs/INDEX.md la provenance et le statut des documents importés.
|
||||
|
||||
[validations]
|
||||
- Vérification que les contenus extraits sont intégrés aux fichiers docs/ concernés.
|
||||
|
||||
[artefacts concernés]
|
||||
- docs/**, archive/**.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# Architecture frontend
|
||||
|
||||
[portée]
|
||||
Qualité du bundle, découpage, état global et couche de services.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Réduire la taille du bundle initial via code splitting.
|
||||
- Éviter le prop drilling via Redux ou Context API.
|
||||
- Abstraire les services de données pour testabilité et maintenance.
|
||||
|
||||
[directives]
|
||||
|
||||
- Mettre en place React.lazy et Suspense pour le chargement différé des vues/segments.
|
||||
- Centraliser l’état global via Redux ou Context API.
|
||||
- Isoler les appels « data » derrière une couche d’abstraction à interface stable.
|
||||
- Interdire l’ajout d’exemples front dans la base de code.
|
||||
|
||||
[validations]
|
||||
|
||||
- Vérifier que les points d’entrée sont minimes et que les segments non critiques sont chargés à la demande.
|
||||
- S’assurer que docs/ARCHITECTURE.md décrit les décisions et les points d’extension.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/ARCHITECTURE.md, docs/TESTING.md.
|
||||
# Architecture frontend
|
||||
|
||||
[portée]
|
||||
Qualité du bundle, découpage, état global et couche de services.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Réduire la taille du bundle initial via code splitting.
|
||||
- Éviter le prop drilling via Redux ou Context API.
|
||||
- Abstraire les services de données pour testabilité et maintenance.
|
||||
|
||||
[directives]
|
||||
|
||||
- Mettre en place React.lazy et Suspense pour le chargement différé des vues/segments.
|
||||
- Centraliser l’état global via Redux ou Context API.
|
||||
- Isoler les appels « data » derrière une couche d’abstraction à interface stable.
|
||||
- Interdire l’ajout d’exemples front dans la base de code.
|
||||
|
||||
[validations]
|
||||
|
||||
- Vérifier que les points d’entrée sont minimes et que les segments non critiques sont chargés à la demande.
|
||||
- S’assurer que docs/ARCHITECTURE.md décrit les décisions et les points d’extension.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- docs/ARCHITECTURE.md, docs/TESTING.md.
|
||||
@ -1,53 +0,0 @@
|
||||
---
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# Versionnage et publication
|
||||
|
||||
[portée]
|
||||
Gestion sémantique des versions, CHANGELOG, confirmation push/tag.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Tenir CHANGELOG.md comme source unique de vérité.
|
||||
- Demander confirmation avant push et tag.
|
||||
|
||||
[directives]
|
||||
|
||||
- À chaque changement significatif, mettre à jour CHANGELOG.md (ajouts, changements, corrections, ruptures).
|
||||
- Proposer un bump semver (major/minor/patch) motivé par l’impact.
|
||||
- Avant tout push ou tag, demander confirmation explicite.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus si modification sans entrée correspondante dans CHANGELOG.md.
|
||||
- Cohérence entre CHANGELOG.md, docs/RELEASE_PLAN.md et docs/ROADMAP.md.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- CHANGELOG.md, docs/RELEASE_PLAN.md, docs/ROADMAP.md.
|
||||
|
||||
# Versionnage et publication
|
||||
|
||||
[portée]
|
||||
Gestion sémantique des versions, CHANGELOG, confirmation push/tag.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Tenir CHANGELOG.md comme source unique de vérité.
|
||||
- Demander confirmation avant push et tag.
|
||||
|
||||
[directives]
|
||||
|
||||
- À chaque changement significatif, mettre à jour CHANGELOG.md (ajouts, changements, corrections, ruptures).
|
||||
- Proposer un bump semver (major/minor/patch) motivé par l’impact.
|
||||
- Avant tout push ou tag, demander confirmation explicite.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus si modification sans entrée correspondante dans CHANGELOG.md.
|
||||
- Cohérence entre CHANGELOG.md, docs/RELEASE_PLAN.md et docs/ROADMAP.md.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- CHANGELOG.md, docs/RELEASE_PLAN.md, docs/ROADMAP.md.
|
||||
@ -1,59 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Open source et Gitea
|
||||
|
||||
[portée]
|
||||
Conformité open source, templates Gitea, CI.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Préparer chaque projet pour un dépôt Gitea (git.4nkweb.com).
|
||||
- Maintenir les fichiers de gouvernance et la CI.
|
||||
|
||||
[directives]
|
||||
|
||||
- Vérifier la présence et l’actualité de : LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, OPEN_SOURCE_CHECKLIST.md.
|
||||
- Maintenir .gitea/ :
|
||||
- ISSUE_TEMPLATE/bug_report.md, feature_request.md
|
||||
- PULL_REQUEST_TEMPLATE.md
|
||||
- workflows/ci.yml
|
||||
- Documenter dans docs/GITEA_SETUP.md la configuration distante et les permissions.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus si un des fichiers « gouvernance/CI » manque.
|
||||
- Cohérence entre docs/OPEN_SOURCE_CHECKLIST.md et l’état du repo.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- .gitea/**, docs/GITEA_SETUP.md, docs/OPEN_SOURCE_CHECKLIST.md.
|
||||
|
||||
# Open source et Gitea
|
||||
|
||||
[portée]
|
||||
Conformité open source, templates Gitea, CI.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Préparer chaque projet pour un dépôt Gitea (git.4nkweb.com).
|
||||
- Maintenir les fichiers de gouvernance et la CI.
|
||||
|
||||
[directives]
|
||||
|
||||
- Vérifier la présence et l’actualité de : LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, OPEN_SOURCE_CHECKLIST.md.
|
||||
- Maintenir .gitea/ :
|
||||
- ISSUE_TEMPLATE/bug_report.md, feature_request.md
|
||||
- PULL_REQUEST_TEMPLATE.md
|
||||
- workflows/ci.yml
|
||||
- Documenter dans docs/GITEA_SETUP.md la configuration distante et les permissions.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refus si un des fichiers « gouvernance/CI » manque.
|
||||
- Cohérence entre docs/OPEN_SOURCE_CHECKLIST.md et l’état du repo.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- .gitea/**, docs/GITEA_SETUP.md, docs/OPEN_SOURCE_CHECKLIST.md.
|
||||
@ -1,53 +0,0 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Tri, diagnostic et résolution de problèmes
|
||||
|
||||
[portée]
|
||||
Boucle de triage : reproduction, diagnostic, correctif, non-régression.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Exécuter automatiquement les étapes de résolution.
|
||||
- Bloquer l’avancement tant que les erreurs ne sont pas corrigées.
|
||||
|
||||
[directives]
|
||||
|
||||
- Étapes obligatoires : reproduction minimale, inspection des logs, bissection des changements, formulation d’hypothèses, tests ciblés, correctif, test de non-régression.
|
||||
- Lorsque plusieurs hypothèses ont été testées, produire un REX dans archive/ avec liens vers les commits.
|
||||
- Poser des questions de cohérence fonctionnelle si des ambiguïtés subsistent (contrats d’API, invariants, SLA).
|
||||
|
||||
[validations]
|
||||
|
||||
- Interdiction de clore une tâche si un test échoue ou si une alerte critique subsiste.
|
||||
- Traçabilité du REX si investigations multiples.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- tests/**, archive/**, docs/TESTING.md, docs/ARCHITECTURE.md.
|
||||
|
||||
# Tri, diagnostic et résolution de problèmes
|
||||
|
||||
[portée]
|
||||
Boucle de triage : reproduction, diagnostic, correctif, non-régression.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Exécuter automatiquement les étapes de résolution.
|
||||
- Bloquer l’avancement tant que les erreurs ne sont pas corrigées.
|
||||
|
||||
[directives]
|
||||
|
||||
- Étapes obligatoires : reproduction minimale, inspection des logs, bissection des changements, formulation d’hypothèses, tests ciblés, correctif, test de non-régression.
|
||||
- Lorsque plusieurs hypothèses ont été testées, produire un REX dans archive/ avec liens vers les commits.
|
||||
- Poser des questions de cohérence fonctionnelle si des ambiguïtés subsistent (contrats d’API, invariants, SLA).
|
||||
|
||||
[validations]
|
||||
|
||||
- Interdiction de clore une tâche si un test échoue ou si une alerte critique subsiste.
|
||||
- Traçabilité du REX si investigations multiples.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- tests/**, archive/**, docs/TESTING.md, docs/ARCHITECTURE.md.
|
||||
@ -1,15 +0,0 @@
|
||||
# Index des règles .cursor/rules
|
||||
|
||||
- 00-foundations.mdc : règles linguistiques et éditoriales (français, pas d’exemples en base, introduction/conclusion).
|
||||
- 10-project-structure.mdc : arborescence canonique 4NK_node et garde-fous.
|
||||
- 20-documentation.mdc : documentation continue, remplacement de « RESUME », INDEX.md.
|
||||
- 30-testing.mdc : tests (unit, integration, connectivity, performance, external), logs/reports.
|
||||
- 40-dependencies-and-build.mdc : dépendances, compilation, corrections bloquantes.
|
||||
- 50-data-csv-models.mdc : CSV avec en-têtes multi-lignes, définition des colonnes.
|
||||
- 60-office-docs.mdc : lecture .docx via docx2txt + repli.
|
||||
- 70-frontend-architecture.mdc : React.lazy/Suspense, état global, couche de services.
|
||||
- 80-versioning-and-release.mdc : CHANGELOG, semver, confirmation push/tag.
|
||||
- 90-gitea-and-oss.mdc : fichiers open source, .gitea, CI, Gitea remote.
|
||||
- 95-triage-and-problem-solving.mdc : boucle de diagnostic, REX, non-régression.
|
||||
|
||||
Ces règles sont conçues pour être ajoutées au contexte de Cursor depuis l’interface (@Cursor Rules) et s’appuient sur le mécanisme de règles projet stockées dans `.cursor/rules/`. :contentReference[oaicite:3]{index=3}
|
||||
@ -1,97 +0,0 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Signaler un bug pour nous aider à améliorer 4NK Node
|
||||
title: '[BUG] '
|
||||
labels: ['bug', 'needs-triage']
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🐛 Description du Bug
|
||||
|
||||
Description claire et concise du problème.
|
||||
|
||||
## 🔄 Étapes pour Reproduire
|
||||
|
||||
1. Aller à '...'
|
||||
2. Cliquer sur '...'
|
||||
3. Faire défiler jusqu'à '...'
|
||||
4. Voir l'erreur
|
||||
|
||||
## ✅ Comportement Attendu
|
||||
|
||||
Description de ce qui devrait se passer.
|
||||
|
||||
## ❌ Comportement Actuel
|
||||
|
||||
Description de ce qui se passe actuellement.
|
||||
|
||||
## 📸 Capture d'Écran
|
||||
|
||||
Si applicable, ajoutez une capture d'écran pour expliquer votre problème.
|
||||
|
||||
## 💻 Informations Système
|
||||
|
||||
- **OS** : [ex: Ubuntu 20.04, macOS 12.0, Windows 11]
|
||||
- **Docker** : [ex: 20.10.0]
|
||||
- **Docker Compose** : [ex: 2.0.0]
|
||||
- **Version 4NK Node** : [ex: v1.0.0]
|
||||
- **Architecture** : [ex: x86_64, ARM64]
|
||||
|
||||
## 📋 Configuration
|
||||
|
||||
### Services Actifs
|
||||
```bash
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Variables d'Environnement
|
||||
```bash
|
||||
# Bitcoin Core
|
||||
BITCOIN_NETWORK=signet
|
||||
BITCOIN_RPC_PORT=18443
|
||||
|
||||
# Blindbit
|
||||
BLINDBIT_PORT=8000
|
||||
|
||||
# SDK Relay
|
||||
SDK_RELAY_PORTS=8090-8095
|
||||
```
|
||||
|
||||
## 📝 Logs
|
||||
|
||||
### Logs Pertinents
|
||||
```
|
||||
Logs pertinents ici
|
||||
```
|
||||
|
||||
### Logs d'Erreur
|
||||
```
|
||||
Logs d'erreur ici
|
||||
```
|
||||
|
||||
### Logs de Debug
|
||||
```
|
||||
Logs de debug ici (si RUST_LOG=debug)
|
||||
```
|
||||
|
||||
## 🔧 Tentatives de Résolution
|
||||
|
||||
- [ ] Redémarrage des services
|
||||
- [ ] Nettoyage des volumes Docker
|
||||
- [ ] Vérification de la connectivité réseau
|
||||
- [ ] Mise à jour des dépendances
|
||||
- [ ] Vérification de la configuration
|
||||
|
||||
## 📚 Contexte Supplémentaire
|
||||
|
||||
Toute autre information pertinente sur le problème.
|
||||
|
||||
## 🔗 Liens Utiles
|
||||
|
||||
- [Documentation](docs/)
|
||||
- [Guide de Dépannage](docs/TROUBLESHOOTING.md)
|
||||
- [Issues Similaires](https://git.4nkweb.com/4nk/4NK_node/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
|
||||
|
||||
---
|
||||
|
||||
**Merci de votre contribution !** 🙏
|
||||
@ -1,156 +0,0 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Proposer une nouvelle fonctionnalité pour 4NK Node
|
||||
title: '[FEATURE] '
|
||||
labels: ['enhancement', 'needs-triage']
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🚀 Résumé
|
||||
|
||||
Description claire et concise de la fonctionnalité souhaitée.
|
||||
|
||||
## 💡 Motivation
|
||||
|
||||
Pourquoi cette fonctionnalité est-elle nécessaire ? Quels problèmes résout-elle ?
|
||||
|
||||
### Problèmes Actuels
|
||||
- Problème 1
|
||||
- Problème 2
|
||||
- Problème 3
|
||||
|
||||
### Avantages de la Solution
|
||||
- Avantage 1
|
||||
- Avantage 2
|
||||
- Avantage 3
|
||||
|
||||
## 🎯 Proposition
|
||||
|
||||
Description détaillée de la fonctionnalité proposée.
|
||||
|
||||
### Fonctionnalités Principales
|
||||
- [ ] Fonctionnalité 1
|
||||
- [ ] Fonctionnalité 2
|
||||
- [ ] Fonctionnalité 3
|
||||
|
||||
### Interface Utilisateur
|
||||
Description de l'interface utilisateur si applicable.
|
||||
|
||||
### API Changes
|
||||
Description des changements d'API si applicable.
|
||||
|
||||
## 🔄 Alternatives Considérées
|
||||
|
||||
Autres solutions envisagées et pourquoi elles n'ont pas été choisies.
|
||||
|
||||
### Alternative 1
|
||||
- **Description** : ...
|
||||
- **Pourquoi rejetée** : ...
|
||||
|
||||
### Alternative 2
|
||||
- **Description** : ...
|
||||
- **Pourquoi rejetée** : ...
|
||||
|
||||
## 📊 Impact
|
||||
|
||||
### Impact sur les Utilisateurs
|
||||
- Impact positif 1
|
||||
- Impact positif 2
|
||||
- Impact négatif potentiel (si applicable)
|
||||
|
||||
### Impact sur l'Architecture
|
||||
- Changements nécessaires
|
||||
- Compatibilité avec l'existant
|
||||
- Performance
|
||||
|
||||
### Impact sur la Maintenance
|
||||
- Complexité ajoutée
|
||||
- Tests nécessaires
|
||||
- Documentation requise
|
||||
|
||||
## 💻 Exemples d'Utilisation
|
||||
|
||||
### Cas d'Usage 1
|
||||
```bash
|
||||
# Exemple de commande ou configuration
|
||||
```
|
||||
|
||||
### Cas d'Usage 2
|
||||
```python
|
||||
# Exemple de code Python
|
||||
```
|
||||
|
||||
### Cas d'Usage 3
|
||||
```javascript
|
||||
// Exemple de code JavaScript
|
||||
```
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
### Tests Nécessaires
|
||||
- [ ] Tests unitaires
|
||||
- [ ] Tests d'intégration
|
||||
- [ ] Tests de performance
|
||||
- [ ] Tests de sécurité
|
||||
- [ ] Tests de compatibilité
|
||||
|
||||
### Scénarios de Test
|
||||
- Scénario 1
|
||||
- Scénario 2
|
||||
- Scénario 3
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### Documentation Requise
|
||||
- [ ] Guide d'utilisation
|
||||
- [ ] Documentation API
|
||||
- [ ] Exemples de code
|
||||
- [ ] Guide de migration
|
||||
- [ ] FAQ
|
||||
|
||||
## 🔧 Implémentation
|
||||
|
||||
### Étapes Proposées
|
||||
1. **Phase 1** : [Description]
|
||||
2. **Phase 2** : [Description]
|
||||
3. **Phase 3** : [Description]
|
||||
|
||||
### Estimation de Temps
|
||||
- **Développement** : X jours/semaines
|
||||
- **Tests** : X jours/semaines
|
||||
- **Documentation** : X jours/semaines
|
||||
- **Total** : X jours/semaines
|
||||
|
||||
### Ressources Nécessaires
|
||||
- Développeur(s)
|
||||
- Testeur(s)
|
||||
- Documentateur(s)
|
||||
- Infrastructure
|
||||
|
||||
## 🎯 Critères de Succès
|
||||
|
||||
Comment mesurer le succès de cette fonctionnalité ?
|
||||
|
||||
- [ ] Critère 1
|
||||
- [ ] Critère 2
|
||||
- [ ] Critère 3
|
||||
|
||||
## 🔗 Liens Utiles
|
||||
|
||||
- [Documentation existante](docs/)
|
||||
- [Issues similaires](https://git.4nkweb.com/4nk/4NK_node/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
- [Roadmap](https://git.4nkweb.com/4nk/4NK_node/projects)
|
||||
- [Discussions](https://git.4nkweb.com/4nk/4NK_node/issues)
|
||||
|
||||
## 📋 Checklist
|
||||
|
||||
- [ ] J'ai vérifié que cette fonctionnalité n'existe pas déjà
|
||||
- [ ] J'ai lu la documentation existante
|
||||
- [ ] J'ai vérifié les issues similaires
|
||||
- [ ] J'ai fourni des exemples d'utilisation
|
||||
- [ ] J'ai considéré l'impact sur l'existant
|
||||
- [ ] J'ai proposé des tests
|
||||
|
||||
---
|
||||
|
||||
**Merci de votre contribution à l'amélioration de 4NK Node !** 🌟
|
||||
@ -1,180 +0,0 @@
|
||||
# Pull Request - 4NK Node
|
||||
|
||||
## 📋 Description
|
||||
|
||||
Description claire et concise des changements apportés.
|
||||
|
||||
### Type de Changement
|
||||
- [ ] 🐛 Bug fix
|
||||
- [ ] ✨ Nouvelle fonctionnalité
|
||||
- [ ] 📚 Documentation
|
||||
- [ ] 🧪 Tests
|
||||
- [ ] 🔧 Refactoring
|
||||
- [ ] 🚀 Performance
|
||||
- [ ] 🔒 Sécurité
|
||||
- [ ] 🎨 Style/UI
|
||||
- [ ] 🏗️ Architecture
|
||||
- [ ] 📦 Build/CI
|
||||
|
||||
### Composants Affectés
|
||||
- [ ] Bitcoin Core
|
||||
- [ ] Blindbit
|
||||
- [ ] SDK Relay
|
||||
- [ ] Tor
|
||||
- [ ] Docker/Infrastructure
|
||||
- [ ] Tests
|
||||
- [ ] Documentation
|
||||
- [ ] Scripts
|
||||
|
||||
## 🔗 Issue(s) Liée(s)
|
||||
|
||||
Fixes #(issue)
|
||||
Relates to #(issue)
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
### Tests Exécutés
|
||||
- [ ] Tests unitaires
|
||||
- [ ] Tests d'intégration
|
||||
- [ ] Tests de connectivité
|
||||
- [ ] Tests externes
|
||||
- [ ] Tests de performance
|
||||
|
||||
### Commandes de Test
|
||||
```bash
|
||||
# Tests complets
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Tests spécifiques
|
||||
./tests/run_unit_tests.sh
|
||||
./tests/run_integration_tests.sh
|
||||
```
|
||||
|
||||
### Résultats des Tests
|
||||
```
|
||||
Résultats des tests ici
|
||||
```
|
||||
|
||||
## 📸 Captures d'Écran
|
||||
|
||||
Si applicable, ajoutez des captures d'écran pour les changements visuels.
|
||||
|
||||
## 🔧 Changements Techniques
|
||||
|
||||
### Fichiers Modifiés
|
||||
- `fichier1.rs` - Description des changements
|
||||
- `fichier2.py` - Description des changements
|
||||
- `docker-compose.yml` - Description des changements
|
||||
|
||||
### Nouveaux Fichiers
|
||||
- `nouveau_fichier.rs` - Description
|
||||
- `nouveau_script.sh` - Description
|
||||
|
||||
### Fichiers Supprimés
|
||||
- `ancien_fichier.rs` - Raison de la suppression
|
||||
|
||||
### Changements de Configuration
|
||||
```yaml
|
||||
# Exemple de changement de configuration
|
||||
service:
|
||||
new_option: value
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### Documentation Mise à Jour
|
||||
- [ ] README.md
|
||||
- [ ] docs/INSTALLATION.md
|
||||
- [ ] docs/USAGE.md
|
||||
- [ ] docs/API.md
|
||||
- [ ] docs/ARCHITECTURE.md
|
||||
|
||||
### Nouvelle Documentation
|
||||
- [ ] Nouveau guide créé
|
||||
- [ ] Exemples ajoutés
|
||||
- [ ] API documentée
|
||||
|
||||
## 🔍 Code Review Checklist
|
||||
|
||||
### Code Quality
|
||||
- [ ] Le code suit les standards du projet
|
||||
- [ ] Les noms de variables/fonctions sont clairs
|
||||
- [ ] Les commentaires sont appropriés
|
||||
- [ ] Pas de code mort ou commenté
|
||||
- [ ] Gestion d'erreurs appropriée
|
||||
|
||||
### Performance
|
||||
- [ ] Pas de régression de performance
|
||||
- [ ] Optimisations appliquées si nécessaire
|
||||
- [ ] Tests de performance ajoutés
|
||||
|
||||
### Sécurité
|
||||
- [ ] Pas de vulnérabilités introduites
|
||||
- [ ] Validation des entrées utilisateur
|
||||
- [ ] Gestion sécurisée des secrets
|
||||
|
||||
### Tests
|
||||
- [ ] Couverture de tests suffisante
|
||||
- [ ] Tests pour les cas d'erreur
|
||||
- [ ] Tests d'intégration si nécessaire
|
||||
|
||||
### Documentation
|
||||
- [ ] Code auto-documenté
|
||||
- [ ] Documentation mise à jour
|
||||
- [ ] Exemples fournis
|
||||
|
||||
## 🚀 Déploiement
|
||||
|
||||
### Impact sur le Déploiement
|
||||
- [ ] Aucun impact
|
||||
- [ ] Migration de données requise
|
||||
- [ ] Changement de configuration
|
||||
- [ ] Redémarrage des services
|
||||
|
||||
### Étapes de Déploiement
|
||||
```bash
|
||||
# Étapes pour déployer les changements
|
||||
```
|
||||
|
||||
## 📊 Métriques
|
||||
|
||||
### Impact sur les Performances
|
||||
- Temps de réponse : +/- X%
|
||||
- Utilisation mémoire : +/- X%
|
||||
- Utilisation CPU : +/- X%
|
||||
|
||||
### Impact sur la Stabilité
|
||||
- Taux d'erreur : +/- X%
|
||||
- Disponibilité : +/- X%
|
||||
|
||||
## 🔄 Compatibilité
|
||||
|
||||
### Compatibilité Ascendante
|
||||
- [ ] Compatible avec les versions précédentes
|
||||
- [ ] Migration automatique
|
||||
- [ ] Migration manuelle requise
|
||||
|
||||
### Compatibilité Descendante
|
||||
- [ ] Compatible avec les futures versions
|
||||
- [ ] API stable
|
||||
- [ ] Configuration stable
|
||||
|
||||
## 🎯 Critères de Succès
|
||||
|
||||
- [ ] Critère 1
|
||||
- [ ] Critère 2
|
||||
- [ ] Critère 3
|
||||
|
||||
## 📝 Notes Supplémentaires
|
||||
|
||||
Informations supplémentaires importantes pour les reviewers.
|
||||
|
||||
## 🔗 Liens Utiles
|
||||
|
||||
- [Documentation](docs/)
|
||||
- [Tests](tests/)
|
||||
- [Issues liées](https://git.4nkweb.com/4nk/4NK_node/issues)
|
||||
|
||||
---
|
||||
|
||||
**Merci pour votre contribution !** 🙏
|
||||
@ -1,313 +0,0 @@
|
||||
name: CI - 4NK Node
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, develop ]
|
||||
pull_request:
|
||||
branches: [ main, develop ]
|
||||
|
||||
env:
|
||||
RUST_VERSION: '1.70'
|
||||
DOCKER_COMPOSE_VERSION: '2.20.0'
|
||||
|
||||
jobs:
|
||||
# Job de vérification du code
|
||||
code-quality:
|
||||
name: Code Quality
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Rust
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ env.RUST_VERSION }}
|
||||
override: true
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-cargo-
|
||||
|
||||
- name: Run clippy
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo clippy --all-targets --all-features -- -D warnings
|
||||
|
||||
- name: Run rustfmt
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo fmt --all -- --check
|
||||
|
||||
- name: Check documentation
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo doc --no-deps
|
||||
|
||||
- name: Check for TODO/FIXME
|
||||
run: |
|
||||
if grep -r "TODO\|FIXME" . --exclude-dir=.git --exclude-dir=target; then
|
||||
echo "Found TODO/FIXME comments. Please address them."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Job de tests unitaires
|
||||
unit-tests:
|
||||
name: Unit Tests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Rust
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ env.RUST_VERSION }}
|
||||
override: true
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-cargo-
|
||||
|
||||
- name: Run unit tests
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo test --lib --bins
|
||||
|
||||
- name: Run integration tests
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo test --tests
|
||||
|
||||
# Job de tests d'intégration
|
||||
integration-tests:
|
||||
name: Integration Tests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
services:
|
||||
docker:
|
||||
image: docker:24.0.5
|
||||
options: >-
|
||||
--health-cmd "docker info"
|
||||
--health-interval 10s
|
||||
--health-timeout 5s
|
||||
--health-retries 5
|
||||
ports:
|
||||
- 2375:2375
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build Docker images
|
||||
run: |
|
||||
docker build -t 4nk-node-bitcoin ./bitcoin
|
||||
docker build -t 4nk-node-blindbit ./blindbit
|
||||
docker build -t 4nk-node-sdk-relay -f ./sdk_relay/Dockerfile ..
|
||||
|
||||
- name: Run integration tests
|
||||
run: |
|
||||
# Tests de connectivité de base
|
||||
./tests/run_connectivity_tests.sh || true
|
||||
|
||||
# Tests d'intégration
|
||||
./tests/run_integration_tests.sh || true
|
||||
|
||||
- name: Upload test results
|
||||
uses: actions/upload-artifact@v3
|
||||
if: always()
|
||||
with:
|
||||
name: test-results
|
||||
path: |
|
||||
tests/logs/
|
||||
tests/reports/
|
||||
retention-days: 7
|
||||
|
||||
# Job de tests de sécurité
|
||||
security-tests:
|
||||
name: Security Tests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Rust
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ env.RUST_VERSION }}
|
||||
override: true
|
||||
|
||||
- name: Run cargo audit
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo audit --deny warnings
|
||||
|
||||
- name: Check for secrets
|
||||
run: |
|
||||
# Vérifier les secrets potentiels
|
||||
if grep -r "password\|secret\|key\|token" . --exclude-dir=.git --exclude-dir=target --exclude=*.md; then
|
||||
echo "Potential secrets found. Please review."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Check file permissions
|
||||
run: |
|
||||
# Vérifier les permissions sensibles
|
||||
find . -type f -perm /0111 -name "*.conf" -o -name "*.key" -o -name "*.pem" | while read file; do
|
||||
if [[ $(stat -c %a "$file") != "600" ]]; then
|
||||
echo "Warning: $file has insecure permissions"
|
||||
fi
|
||||
done
|
||||
|
||||
# Job de build et test Docker
|
||||
docker-build:
|
||||
name: Docker Build & Test
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
services:
|
||||
docker:
|
||||
image: docker:24.0.5
|
||||
options: >-
|
||||
--health-cmd "docker info"
|
||||
--health-interval 10s
|
||||
--health-timeout 5s
|
||||
--health-retries 5
|
||||
ports:
|
||||
- 2375:2375
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build and test Bitcoin Core
|
||||
run: |
|
||||
docker build -t 4nk-node-bitcoin:test ./bitcoin
|
||||
docker run --rm 4nk-node-bitcoin:test bitcoin-cli --version
|
||||
|
||||
- name: Build and test Blindbit
|
||||
run: |
|
||||
docker build -t 4nk-node-blindbit:test ./blindbit
|
||||
docker run --rm 4nk-node-blindbit:test --version || true
|
||||
|
||||
- name: Build and test SDK Relay
|
||||
run: |
|
||||
docker build -t 4nk-node-sdk-relay:test -f ./sdk_relay/Dockerfile ..
|
||||
docker run --rm 4nk-node-sdk-relay:test --version || true
|
||||
|
||||
- name: Test Docker Compose
|
||||
run: |
|
||||
docker-compose config
|
||||
docker-compose build --no-cache
|
||||
|
||||
# Job de tests de documentation
|
||||
documentation-tests:
|
||||
name: Documentation Tests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Check markdown links
|
||||
run: |
|
||||
# Vérification basique des liens markdown
|
||||
find . -name "*.md" -exec grep -l "\[.*\](" {} \; | while read file; do
|
||||
echo "Checking links in $file"
|
||||
done
|
||||
|
||||
- name: Check documentation structure
|
||||
run: |
|
||||
# Vérifier la présence des fichiers de documentation essentiels
|
||||
required_files=(
|
||||
"README.md"
|
||||
"LICENSE"
|
||||
"CONTRIBUTING.md"
|
||||
"CHANGELOG.md"
|
||||
"CODE_OF_CONDUCT.md"
|
||||
"SECURITY.md"
|
||||
"docs/INDEX.md"
|
||||
"docs/INSTALLATION.md"
|
||||
"docs/USAGE.md"
|
||||
)
|
||||
|
||||
for file in "${required_files[@]}"; do
|
||||
if [[ ! -f "$file" ]]; then
|
||||
echo "Missing required documentation file: $file"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Validate documentation
|
||||
run: |
|
||||
# Vérifier la cohérence de la documentation
|
||||
if ! grep -q "4NK Node" README.md; then
|
||||
echo "README.md should mention '4NK Node'"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Job de tests de performance
|
||||
performance-tests:
|
||||
name: Performance Tests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Rust
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ env.RUST_VERSION }}
|
||||
override: true
|
||||
|
||||
- name: Run performance tests
|
||||
run: |
|
||||
cd sdk_relay
|
||||
cargo test --release --test performance_tests || true
|
||||
|
||||
- name: Check memory usage
|
||||
run: |
|
||||
# Tests de base de consommation mémoire
|
||||
echo "Performance tests completed"
|
||||
|
||||
# Job de notification
|
||||
notify:
|
||||
name: Notify
|
||||
runs-on: ubuntu-latest
|
||||
needs: [code-quality, unit-tests, integration-tests, security-tests, docker-build, documentation-tests]
|
||||
if: always()
|
||||
|
||||
steps:
|
||||
- name: Notify success
|
||||
if: needs.code-quality.result == 'success' && needs.unit-tests.result == 'success' && needs.integration-tests.result == 'success' && needs.security-tests.result == 'success' && needs.docker-build.result == 'success' && needs.documentation-tests.result == 'success'
|
||||
run: |
|
||||
echo "✅ All tests passed successfully!"
|
||||
|
||||
- name: Notify failure
|
||||
if: needs.code-quality.result == 'failure' || needs.unit-tests.result == 'failure' || needs.integration-tests.result == 'failure' || needs.security-tests.result == 'failure' || needs.docker-build.result == 'failure' || needs.documentation-tests.result == 'failure'
|
||||
run: |
|
||||
echo "❌ Some tests failed!"
|
||||
exit 1
|
||||
258
AGENTS.md
258
AGENTS.md
@ -1,258 +0,0 @@
|
||||
# AGENTS.md
|
||||
|
||||
## Table des matières
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Agents fondamentaux](#agents-fondamentaux)
|
||||
- [Agents spécialisés documentation](#agents-spécialisés-documentation)
|
||||
- [Agents spécialisés tests](#agents-spécialisés-tests)
|
||||
- [Agents techniques](#agents-techniques)
|
||||
- [Agents frontend](#agents-frontend)
|
||||
- [Agents open source et CI](#agents-open-source-et-ci)
|
||||
- [Agents complémentaires](#agents-complémentaires)
|
||||
- [Matrice de coordination](#matrice-de-coordination)
|
||||
- [Conclusion](#conclusion)
|
||||
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
Ce document définit les agents, leurs rôles et leurs responsabilités dans le projet `4NK/4NK_node`.
|
||||
Chaque agent est assigné à un périmètre clair (documentation, tests, dépendances, données, CI, gouvernance open source).
|
||||
L’objectif est d’assurer une maintenance cohérente de l’arborescence, une traçabilité complète et une exécution fiable des bonnes pratiques.
|
||||
Les règles détaillées de réalisation et de contrôle sont précisées dans `.cursor/rules/`.
|
||||
|
||||
---
|
||||
|
||||
## Agents fondamentaux
|
||||
|
||||
### Agent Fondation
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Garantir que toute production est en français.
|
||||
- Vérifier l’absence d’exemples de code applicatif dans la base de code.
|
||||
- Imposer l’introduction et/ou conclusion dans chaque contenu.
|
||||
|
||||
**Artefacts :**
|
||||
|
||||
- Tous fichiers.
|
||||
|
||||
---
|
||||
|
||||
### Agent Structure
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Maintenir l’arborescence canonique du projet.
|
||||
- Déplacer les documents obsolètes vers `archive/`.
|
||||
- Bloquer toute suppression non documentée.
|
||||
|
||||
**Artefacts :**
|
||||
|
||||
- `archive/`, `docs/`, `tests/`, `.gitea/`, `CHANGELOG.md`.
|
||||
|
||||
---
|
||||
|
||||
## Agents spécialisés documentation
|
||||
|
||||
### Agent Documentation
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Mettre à jour les fichiers de `docs/` selon l’impact des changements.
|
||||
- Maintenir `INDEX.md` comme table des matières centrale.
|
||||
- Produire des REX techniques dans `archive/`.
|
||||
|
||||
---
|
||||
|
||||
### Agent Données CSV
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Considérer les CSV comme source de vérité des modèles de données.
|
||||
- Confirmer la structure et exiger une définition des colonnes.
|
||||
- Corriger automatiquement les incohérences de type documentées.
|
||||
|
||||
---
|
||||
|
||||
### Agent Documents bureautiques
|
||||
|
||||
**Rôle (Consulté)** :
|
||||
|
||||
- Lire les `.docx` via `docx2txt`.
|
||||
- Proposer des alternatives en cas d’échec.
|
||||
- Documenter les imports dans `INDEX.md`.
|
||||
|
||||
---
|
||||
|
||||
## Agents spécialisés tests
|
||||
|
||||
### Agent Tests
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Maintenir la couverture : `unit`, `integration`, `connectivity`, `performance`, `external`.
|
||||
- Gérer `tests/logs` et `tests/reports`.
|
||||
- Exiger des tests verts avant commit.
|
||||
|
||||
---
|
||||
|
||||
### Agent Performance
|
||||
|
||||
**Rôle (Consulté)** :
|
||||
|
||||
- Conduire des benchmarks reproductibles.
|
||||
- Vérifier l’impact performance avant toute fusion.
|
||||
|
||||
---
|
||||
|
||||
## Agents techniques
|
||||
|
||||
### Agent Dépendances
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Ajouter automatiquement les dépendances manquantes.
|
||||
- Vérifier les dernières versions stables.
|
||||
- Documenter les changements dans `ARCHITECTURE.md`, `CONFIGURATION.md` et `CHANGELOG.md`.
|
||||
|
||||
---
|
||||
|
||||
### Agent Compilation
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Compiler très régulièrement et à chaque étape critique.
|
||||
- Bloquer toute progression en présence d’erreurs.
|
||||
|
||||
---
|
||||
|
||||
### Agent Résolution
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Exécuter systématiquement la boucle de diagnostic (reproduction, logs, bissection, hypothèses, correctif, non-régression).
|
||||
- Produire un REX en cas d’hypothèses multiples.
|
||||
|
||||
---
|
||||
|
||||
## Agents frontend
|
||||
|
||||
### Agent Frontend
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Implémenter le code splitting (`React.lazy`, `Suspense`).
|
||||
- Centraliser l’état via Redux ou Context API.
|
||||
- Créer une couche d’abstraction pour les services de données.
|
||||
|
||||
---
|
||||
|
||||
## Agents open source et CI
|
||||
|
||||
### Agent Open Source
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Maintenir à jour : `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `OPEN_SOURCE_CHECKLIST.md`.
|
||||
- Vérifier l’alignement continu avec `4NK_node`.
|
||||
|
||||
---
|
||||
|
||||
### Agent Gitea
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Vérifier la présence et l’actualité de `.gitea/ISSUE_TEMPLATE/*`, `PULL_REQUEST_TEMPLATE.md`, `.gitea/workflows/ci.yml`.
|
||||
- Documenter la configuration dans `docs/GITEA_SETUP.md`.
|
||||
|
||||
---
|
||||
|
||||
### Agent Versionnage
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Maintenir `CHANGELOG.md` comme source unique de vérité.
|
||||
- Proposer un bump semver justifié.
|
||||
- Demander confirmation avant push et tag.
|
||||
|
||||
---
|
||||
|
||||
## Agents complémentaires
|
||||
|
||||
### Agent Coordination
|
||||
|
||||
**Rôle (Accountable)** :
|
||||
|
||||
- Vérifier que tous les agents concernés ont bien agi lors d’un changement complexe.
|
||||
- Consolider les validations avant merge.
|
||||
|
||||
---
|
||||
|
||||
### Agent Qualité / Linting
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Appliquer les règles de style, lint et sécurité statique.
|
||||
- Surveiller la dette technique et l’accessibilité.
|
||||
|
||||
---
|
||||
|
||||
### Agent Release Manager
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Superviser le passage d’une version à l’autre.
|
||||
- Vérifier la cohérence entre `CHANGELOG.md`, `ROADMAP.md` et les tags Git.
|
||||
- Déclencher les workflows CI/CD de release.
|
||||
|
||||
---
|
||||
|
||||
### Agent Sécurité proactive
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- Surveiller les dépendances vulnérables (CVE, advisories).
|
||||
- Mettre à jour `SECURITY_AUDIT.md` et notifier l’agent Dépendances.
|
||||
|
||||
---
|
||||
|
||||
### Agent Contributeurs externes
|
||||
|
||||
**Rôle (Consulté)** :
|
||||
|
||||
- Encadrer la réception de PRs et issues communautaires.
|
||||
- Veiller au respect de `CODE_OF_CONDUCT.md`.
|
||||
|
||||
---
|
||||
|
||||
### Agent Documentation communautaire
|
||||
|
||||
**Rôle (Responsable)** :
|
||||
|
||||
- S’assurer que `COMMUNITY_GUIDE.md` et `OPEN_SOURCE_CHECKLIST.md` sont accessibles, clairs et alignés avec l’expérience contributeurs.
|
||||
|
||||
---
|
||||
|
||||
## Matrice de coordination
|
||||
|
||||
| Type de changement | Agents impliqués | Artefacts principaux | Validation obligatoire |
|
||||
|--------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------------|
|
||||
| Ajout de fonctionnalité | Documentation, Tests, Dépendances, Frontend | API.md, USAGE.md, ARCHITECTURE.md, tests/unit, tests/integration, CHANGELOG.md (*Added*), README.md | Oui |
|
||||
| Correction de bug | Résolution, Tests, Documentation | tests/unit, TESTING.md, archive/, CHANGELOG.md (*Fixed*) | Oui |
|
||||
| Refactorisation / amélioration | Structure, Documentation, Compilation | ARCHITECTURE.md, archive/, CHANGELOG.md (*Changed*) | Oui |
|
||||
| Dépendance ajoutée/mise à jour | Dépendances, Compilation, Documentation | ARCHITECTURE.md, CONFIGURATION.md, CHANGELOG.md (*Dependencies*) | Oui |
|
||||
| Données CSV modifiées | Données CSV, Documentation, Tests | API.md, ARCHITECTURE.md, USAGE.md, tests/unit, CHANGELOG.md (*Data model update*) | Oui |
|
||||
| Migration / breaking change | Documentation, Tests, Résolution, Versionnage | MIGRATION.md, INSTALLATION.md, RELEASE_PLAN.md, ROADMAP.md, tests/integration, CHANGELOG.md (*Breaking*)| Oui |
|
||||
| Sécurité / audit | Documentation, Tests, Open Source, Sécurité proactive | SECURITY_AUDIT.md, tests/external, tests/connectivity, CHANGELOG.md (*Security*) | Oui |
|
||||
| Préparation open source / CI | Open Source, Gitea, Versionnage, Documentation communautaire, Contributeurs externes | .gitea/**, GITEA_SETUP.md, OPEN_SOURCE_CHECKLIST.md, CHANGELOG.md (*CI/CD* / *Governance*) | Oui |
|
||||
| Optimisation performance | Performance, Tests, Documentation | tests/performance, tests/reports, ARCHITECTURE.md, CHANGELOG.md (*Performance*) | Oui |
|
||||
| Évolution frontend | Frontend, Documentation, Tests | ARCHITECTURE.md, USAGE.md, tests/integration, CHANGELOG.md (*Frontend*) | Oui |
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
Le présent `AGENTS.md` formalise non seulement les rôles et responsabilités, mais également la coordination opérationnelle entre agents pour chaque type de changement.
|
||||
Grâce à la table des matières, aux agents complémentaires et à la matrice structurée, ce fichier constitue une référence vivante garantissant la cohérence entre code, documentation, tests, dépendances, CI/CD et gouvernance open source.
|
||||
219
CHANGELOG.md
219
CHANGELOG.md
@ -1,219 +0,0 @@
|
||||
# Changelog - 4NK Node
|
||||
|
||||
Tous les changements notables de ce projet seront documentés dans ce fichier.
|
||||
|
||||
Le format est basé sur [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/),
|
||||
et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
- Fichiers docs manquants référencés par l’index: `SECURITY.md`, `GITEA_SETUP.md`, `DEVELOPMENT.md`, `INTEGRATION_4NK_NODE.md`, `ETAT_ACTUEL.md`, `RESUME_FINAL.md`, `SUPPORT.md`, `EXTERNAL_NODES.md`, `RELAY_NETWORK.md`.
|
||||
|
||||
### Changed
|
||||
- Correction de liens internes dans `docs/COMMUNITY_GUIDE.md`.
|
||||
- Vérification et consolidation de `docs/INDEX.md`.
|
||||
|
||||
### Fixed
|
||||
- Compilation locale validée; aucun échec bloquant.
|
||||
|
||||
## [1.0.0] - 2024-12-19
|
||||
|
||||
### Added
|
||||
- Infrastructure Docker complète pour 4NK Node
|
||||
- Support des paiements silencieux (Silent Payments) Bitcoin
|
||||
- Nœud Bitcoin Core configuré en mode signet
|
||||
- Service Blindbit pour les filtres de paiements silencieux
|
||||
- Service SDK Relay avec synchronisation mesh
|
||||
- Service Tor pour l'anonymat
|
||||
- Configuration multi-relais (3 instances)
|
||||
- Synchronisation automatique entre relais
|
||||
- Cache de déduplication des messages
|
||||
- Healthchecks pour tous les services
|
||||
- Scripts d'automatisation (démarrage, redémarrage, monitoring)
|
||||
- Tests de connectivité et d'intégration
|
||||
- Documentation complète en français
|
||||
|
||||
### Features
|
||||
- **Bitcoin Core** : Nœud signet avec RPC et ZMQ
|
||||
- **Blindbit** : Service de filtres pour les paiements silencieux
|
||||
- **SDK Relay** : Relais avec interface WebSocket et synchronisation mesh
|
||||
- **Tor** : Proxy anonyme pour Bitcoin Core
|
||||
- **Synchronisation** : Système de synchronisation entre relais
|
||||
- **Monitoring** : Scripts de monitoring et surveillance
|
||||
- **Tests** : Suite de tests complète
|
||||
|
||||
### Technical
|
||||
- Architecture Docker avec orchestration via Docker Compose
|
||||
- Réseau privé `btcnet` pour la communication inter-services
|
||||
- Volumes persistants pour les données
|
||||
- Configuration externalisée via fichiers .conf
|
||||
- Logging structuré avec rotation
|
||||
- Gestion des erreurs et retry automatique
|
||||
|
||||
## [0.9.0] - 2024-12-15
|
||||
|
||||
### Added
|
||||
- Version initiale de l'infrastructure
|
||||
- Configuration de base des services
|
||||
- Tests de connectivité simples
|
||||
- Documentation de base
|
||||
|
||||
### Changed
|
||||
- Configuration initiale des services Docker
|
||||
- Premiers tests d'intégration
|
||||
|
||||
### Fixed
|
||||
- Problèmes de connectivité initiale
|
||||
- Configuration des ports et réseaux
|
||||
|
||||
## [0.8.0] - 2024-12-10
|
||||
|
||||
### Added
|
||||
- Support de la synchronisation entre relais
|
||||
- Implémentation du cache de déduplication
|
||||
- Types de messages de synchronisation
|
||||
- Gestionnaire de synchronisation (SyncManager)
|
||||
|
||||
### Changed
|
||||
- Amélioration de l'architecture de synchronisation
|
||||
- Optimisation des performances de synchronisation
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de synchronisation
|
||||
- Amélioration de la stabilité des connexions mesh
|
||||
|
||||
## [0.7.0] - 2024-12-05
|
||||
|
||||
### Added
|
||||
- Support des paiements silencieux
|
||||
- Intégration avec le service Blindbit
|
||||
- Tests de paiements silencieux
|
||||
- Documentation des APIs
|
||||
|
||||
### Changed
|
||||
- Amélioration de l'intégration Bitcoin Core
|
||||
- Optimisation du scan des blocs
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de détection des paiements
|
||||
- Amélioration de la performance du scan
|
||||
|
||||
## [0.6.0] - 2024-11-30
|
||||
|
||||
### Added
|
||||
- Interface WebSocket pour SDK Relay
|
||||
- Support des messages temps réel
|
||||
- Tests WebSocket
|
||||
- Documentation de l'API WebSocket
|
||||
|
||||
### Changed
|
||||
- Amélioration de l'interface WebSocket
|
||||
- Optimisation des performances de communication
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de connexion WebSocket
|
||||
- Amélioration de la gestion des erreurs
|
||||
|
||||
## [0.5.0] - 2024-11-25
|
||||
|
||||
### Added
|
||||
- Support de Tor pour l'anonymat
|
||||
- Configuration du proxy Tor
|
||||
- Tests de connectivité Tor
|
||||
- Documentation de la configuration Tor
|
||||
|
||||
### Changed
|
||||
- Amélioration de la configuration réseau
|
||||
- Optimisation de la connectivité anonyme
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de connectivité Tor
|
||||
- Amélioration de la stabilité du proxy
|
||||
|
||||
## [0.4.0] - 2024-11-20
|
||||
|
||||
### Added
|
||||
- Configuration multi-relais
|
||||
- Support de 3 instances SDK Relay
|
||||
- Tests multi-relais
|
||||
- Documentation de la configuration multi-relais
|
||||
|
||||
### Changed
|
||||
- Amélioration de l'orchestration Docker
|
||||
- Optimisation de la configuration multi-relais
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de configuration multi-relais
|
||||
- Amélioration de la stabilité des instances multiples
|
||||
|
||||
## [0.3.0] - 2024-11-15
|
||||
|
||||
### Added
|
||||
- Healthchecks pour tous les services
|
||||
- Scripts de monitoring
|
||||
- Tests de santé des services
|
||||
- Documentation des healthchecks
|
||||
|
||||
### Changed
|
||||
- Amélioration de la surveillance des services
|
||||
- Optimisation des healthchecks
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes de healthchecks
|
||||
- Amélioration de la détection des problèmes
|
||||
|
||||
## [0.2.0] - 2024-11-10
|
||||
|
||||
### Added
|
||||
- Service Blindbit
|
||||
- Intégration avec Bitcoin Core
|
||||
- Tests d'intégration Blindbit
|
||||
- Documentation du service Blindbit
|
||||
|
||||
### Changed
|
||||
- Amélioration de l'intégration des services
|
||||
- Optimisation de la communication inter-services
|
||||
|
||||
### Fixed
|
||||
- Correction des problèmes d'intégration
|
||||
- Amélioration de la stabilité des services
|
||||
|
||||
## [0.1.0] - 2024-11-05
|
||||
|
||||
### Added
|
||||
- Infrastructure Docker de base
|
||||
- Service Bitcoin Core
|
||||
- Configuration de base
|
||||
- Tests de connectivité simples
|
||||
- Documentation initiale
|
||||
|
||||
### Changed
|
||||
- Configuration initiale des services
|
||||
- Premiers tests d'intégration
|
||||
|
||||
### Fixed
|
||||
- Problèmes de configuration initiale
|
||||
- Correction des problèmes de connectivité de base
|
||||
|
||||
---
|
||||
|
||||
## Types de Changements
|
||||
|
||||
- **Added** : Nouvelles fonctionnalités
|
||||
- **Changed** : Changements dans les fonctionnalités existantes
|
||||
- **Deprecated** : Fonctionnalités qui seront supprimées
|
||||
- **Removed** : Fonctionnalités supprimées
|
||||
- **Fixed** : Corrections de bugs
|
||||
- **Security** : Améliorations de sécurité
|
||||
|
||||
## Contribution
|
||||
|
||||
Pour contribuer au changelog, suivez le format existant et ajoutez vos changements dans la section appropriée.
|
||||
|
||||
## Liens
|
||||
|
||||
- [Documentation](docs/)
|
||||
- [Guide de Contribution](CONTRIBUTING.md)
|
||||
- [Issues](https://git.4nkweb.com/4nk/4NK_node/issues)
|
||||
- [Releases](https://git.4nkweb.com/4nk/4NK_node/releases)
|
||||
@ -1,93 +0,0 @@
|
||||
# Code de Conduite - 4NK Node
|
||||
|
||||
## Notre Engagement
|
||||
|
||||
Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous, en tant que contributeurs et mainteneurs, nous engageons à faire de la participation à notre projet et à notre communauté une expérience sans harcèlement pour tous, peu importe l'âge, la taille, le handicap, l'ethnicité, les caractéristiques sexuelles, l'identité et l'expression de genre, le niveau d'expérience, l'éducation, le statut socio-économique, la nationalité, l'apparence personnelle, la race, la religion ou l'identité et l'orientation sexuelles.
|
||||
|
||||
## Nos Standards
|
||||
|
||||
Exemples de comportements qui contribuent à créer un environnement positif :
|
||||
|
||||
* Utiliser un langage accueillant et inclusif
|
||||
* Respecter les différents points de vue et expériences
|
||||
* Accepter gracieusement les critiques constructives
|
||||
* Se concentrer sur ce qui est le mieux pour la communauté
|
||||
* Faire preuve d'empathie envers les autres membres de la communauté
|
||||
|
||||
Exemples de comportements inacceptables :
|
||||
|
||||
* L'utilisation de langage ou d'imagerie sexualisés et d'attention ou d'avances sexuelles non désirées
|
||||
* Le trolling, les commentaires insultants/désobligeants et les attaques personnelles ou politiques
|
||||
* Le harcèlement public ou privé
|
||||
* Publier les informations privées d'autres personnes, telles que des adresses physiques ou électroniques, sans permission explicite
|
||||
* Autres comportements qui pourraient raisonnablement être considérés comme inappropriés dans un contexte professionnel
|
||||
|
||||
## Nos Responsabilités
|
||||
|
||||
Les mainteneurs du projet sont responsables de clarifier les standards de comportement acceptable et sont censés prendre des mesures correctives appropriées et équitables en réponse à tout cas de comportement inacceptable.
|
||||
|
||||
Les mainteneurs du projet ont le droit et la responsabilité de supprimer, modifier ou rejeter les commentaires, commits, code, modifications de wiki, questions et autres contributions qui ne sont pas alignés avec ce Code de Conduite, et de bannir temporairement ou définitivement tout contributeur pour d'autres comportements qu'ils jugent inappropriés, menaçants, offensants ou nuisibles.
|
||||
|
||||
## Portée
|
||||
|
||||
Ce Code de Conduite s'applique à la fois dans les espaces du projet et dans les espaces publics lorsqu'un individu représente le projet ou sa communauté. Des exemples de représentation du projet ou de la communauté incluent l'utilisation d'une adresse email officielle du projet, la publication via un compte de média social officiel, ou l'action en tant que représentant désigné lors d'un événement en ligne ou hors ligne. La représentation du projet peut être davantage définie et clarifiée par les mainteneurs du projet.
|
||||
|
||||
## Application
|
||||
|
||||
Les cas de comportement abusif, harcelant ou autrement inacceptable peuvent être signalés en contactant l'équipe du projet à contact@4nkweb5.com. Toutes les plaintes seront examinées et enquêtées et se traduiront par une réponse jugée nécessaire et appropriée aux circonstances. L'équipe du projet est obligée de maintenir la confidentialité concernant le rapporteur d'un incident. Plus de détails sur les politiques d'application spécifiques peuvent être publiés séparément.
|
||||
|
||||
Les mainteneurs du projet qui ne suivent pas ou n'appliquent pas le Code de Conduite de bonne foi peuvent faire face à des répercussions temporaires ou permanentes déterminées par d'autres membres de la direction du projet.
|
||||
|
||||
## Attribution
|
||||
|
||||
Ce Code de Conduite est adapté du [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, disponible à https://www.contributor-covenant.org/fr/version/2/0/code_of_conduct.html.
|
||||
|
||||
## Contact
|
||||
|
||||
Pour signaler un problème ou poser des questions concernant ce Code de Conduite, vous pouvez :
|
||||
|
||||
* Créer une issue privée sur le repository
|
||||
* Contacter l'équipe de maintenance via les canaux officiels
|
||||
* Utiliser les canaux de discussion du projet
|
||||
|
||||
## Équipe de Modération
|
||||
|
||||
L'équipe de modération est composée des mainteneurs principaux du projet qui s'engagent à :
|
||||
|
||||
* Traiter tous les signalements avec impartialité
|
||||
* Maintenir la confidentialité des rapports
|
||||
* Prendre des mesures appropriées et équitables
|
||||
* Documenter les décisions prises
|
||||
* Améliorer continuellement le processus
|
||||
|
||||
## Processus de Signalement
|
||||
|
||||
1. **Signalement** : Contactez l'équipe via les canaux appropriés
|
||||
2. **Accusé de réception** : Vous recevrez une confirmation dans les 48h
|
||||
3. **Enquête** : L'équipe examinera le signalement
|
||||
4. **Décision** : Une décision sera prise et communiquée
|
||||
5. **Appel** : Possibilité de faire appel de la décision
|
||||
|
||||
## Mesures Correctives
|
||||
|
||||
Les mesures correctives peuvent inclure :
|
||||
|
||||
* Avertissement privé
|
||||
* Avertissement public
|
||||
* Suspension temporaire
|
||||
* Bannissement permanent
|
||||
* Suppression de contenu inapproprié
|
||||
|
||||
## Engagement envers l'Amélioration
|
||||
|
||||
Nous nous engageons à :
|
||||
|
||||
* Réviser régulièrement ce Code de Conduite
|
||||
* Solliciter les retours de la communauté
|
||||
* Améliorer les processus de modération
|
||||
* Former l'équipe de modération
|
||||
* Maintenir un environnement sain et inclusif
|
||||
|
||||
---
|
||||
|
||||
**Merci de contribuer à maintenir 4NK Node comme un projet accueillant et inclusif !** 🌟
|
||||
372
CONTRIBUTING.md
372
CONTRIBUTING.md
@ -1,372 +0,0 @@
|
||||
# Guide de Contribution - 4NK Node
|
||||
|
||||
Merci de votre intérêt pour contribuer au projet 4NK Node ! Ce guide vous aidera à comprendre comment participer au développement de cette infrastructure pour les paiements silencieux Bitcoin.
|
||||
|
||||
## 📋 Table des Matières
|
||||
|
||||
- [🎯 Comment Contribuer](#-comment-contribuer)
|
||||
- [🚀 Premiers Pas](#-premiers-pas)
|
||||
- [🔧 Environnement de Développement](#️-environnement-de-développement)
|
||||
- [📝 Processus de Contribution](#-processus-de-contribution)
|
||||
- [🧪 Tests](#-tests)
|
||||
- [📚 Documentation](#-documentation)
|
||||
- [🐛 Signaler un Bug](#-signaler-un-bug)
|
||||
- [💡 Proposer une Fonctionnalité](#-proposer-une-fonctionnalité)
|
||||
- [🔍 Code Review](#-code-review)
|
||||
- [📦 Release](#-release)
|
||||
|
||||
## 🎯 Comment Contribuer
|
||||
|
||||
### Types de Contributions
|
||||
|
||||
Nous accueillons différents types de contributions :
|
||||
|
||||
- **🐛 Bug fixes** - Correction de bugs et problèmes
|
||||
- **✨ Nouvelles fonctionnalités** - Ajout de nouvelles capacités
|
||||
- **📚 Documentation** - Amélioration de la documentation
|
||||
- **🧪 Tests** - Ajout ou amélioration des tests
|
||||
- **🔧 Outils** - Amélioration des scripts et outils
|
||||
- **🌐 Traductions** - Traduction de la documentation
|
||||
- **📊 Performance** - Optimisations de performance
|
||||
- **🔒 Sécurité** - Améliorations de sécurité
|
||||
|
||||
### Niveaux de Contribution
|
||||
|
||||
- **Débutant** - Documentation, tests, petits bugs
|
||||
- **Intermédiaire** - Nouvelles fonctionnalités, améliorations
|
||||
- **Avancé** - Architecture, optimisations majeures
|
||||
|
||||
## 🚀 Premiers Pas
|
||||
|
||||
### Prérequis
|
||||
|
||||
- **Docker** et **Docker Compose** installés
|
||||
- **Git** configuré
|
||||
- **Python 3.8+** (pour les tests)
|
||||
- **Rust** (pour le développement sdk_relay)
|
||||
- **Connexion Internet** stable
|
||||
|
||||
### Fork et Clone
|
||||
|
||||
```bash
|
||||
# 1. Fork le repository sur Gitea
|
||||
# 2. Clone votre fork
|
||||
git clone https://git.4nkweb.com/votre-username/4NK_node.git
|
||||
cd 4NK_node
|
||||
|
||||
# 3. Ajouter le repository original comme upstream
|
||||
git remote add upstream https://git.4nkweb.com/4nk/4NK_node.git
|
||||
```
|
||||
|
||||
### Branches
|
||||
|
||||
```bash
|
||||
# Créer une branche pour votre contribution
|
||||
git checkout -b feature/nom-de-votre-feature
|
||||
# ou
|
||||
git checkout -b fix/nom-du-bug
|
||||
```
|
||||
|
||||
## 🔧 Environnement de Développement
|
||||
|
||||
### Installation Locale
|
||||
|
||||
```bash
|
||||
# 1. Cloner le repository
|
||||
git clone https://git.4nkweb.com/4nk/4NK_node.git
|
||||
cd 4NK_node
|
||||
|
||||
# 2. Démarrer l'infrastructure
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# 3. Vérifier que tout fonctionne
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Configuration de Développement
|
||||
|
||||
```bash
|
||||
# Variables d'environnement pour le développement
|
||||
export RUST_LOG=debug
|
||||
export ENABLE_SYNC_TEST=1
|
||||
export BITCOIN_NETWORK=signet
|
||||
```
|
||||
|
||||
### Outils de Développement
|
||||
|
||||
```bash
|
||||
# Tests
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Linting (si configuré)
|
||||
cargo clippy
|
||||
rustfmt src/
|
||||
|
||||
# Build
|
||||
docker-compose build
|
||||
```
|
||||
|
||||
## 📝 Processus de Contribution
|
||||
|
||||
### 1. Planifier Votre Contribution
|
||||
|
||||
- [ ] Vérifier les issues existantes
|
||||
- [ ] Créer une issue si nécessaire
|
||||
- [ ] Discuter de l'approche avec l'équipe
|
||||
- [ ] Planifier les tests et la documentation
|
||||
|
||||
### 2. Développer
|
||||
|
||||
- [ ] Créer une branche depuis `main`
|
||||
- [ ] Développer votre fonctionnalité
|
||||
- [ ] Ajouter des tests
|
||||
- [ ] Mettre à jour la documentation
|
||||
- [ ] Vérifier que les tests passent
|
||||
|
||||
### 3. Soumettre
|
||||
|
||||
- [ ] Commiter avec des messages clairs
|
||||
- [ ] Pousser vers votre fork
|
||||
- [ ] Créer une Pull Request
|
||||
- [ ] Remplir le template de PR
|
||||
|
||||
### Messages de Commit
|
||||
|
||||
Utilisez le format conventionnel :
|
||||
|
||||
```bash
|
||||
# Format
|
||||
type(scope): description
|
||||
|
||||
# Exemples
|
||||
feat(sdk_relay): add new sync type for metrics
|
||||
fix(bitcoin): resolve connection timeout issue
|
||||
docs(api): update WebSocket message format
|
||||
test(integration): add multi-relay sync tests
|
||||
```
|
||||
|
||||
**Types :**
|
||||
- `feat` - Nouvelle fonctionnalité
|
||||
- `fix` - Correction de bug
|
||||
- `docs` - Documentation
|
||||
- `style` - Formatage
|
||||
- `refactor` - Refactoring
|
||||
- `test` - Tests
|
||||
- `chore` - Maintenance
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
### Exécuter les Tests
|
||||
|
||||
```bash
|
||||
# Tous les tests
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Tests par catégorie
|
||||
./tests/run_unit_tests.sh
|
||||
./tests/run_integration_tests.sh
|
||||
./tests/run_connectivity_tests.sh
|
||||
./tests/run_external_tests.sh
|
||||
|
||||
# Tests avec debug
|
||||
./tests/run_all_tests.sh --debug
|
||||
```
|
||||
|
||||
### Ajouter des Tests
|
||||
|
||||
```bash
|
||||
# Structure recommandée
|
||||
tests/
|
||||
├── unit/ # Tests unitaires
|
||||
├── integration/ # Tests d'intégration
|
||||
├── connectivity/ # Tests de connectivité
|
||||
├── external/ # Tests externes
|
||||
└── performance/ # Tests de performance
|
||||
```
|
||||
|
||||
### Bonnes Pratiques
|
||||
|
||||
- Testez tous les cas d'usage
|
||||
- Incluez des tests d'erreur
|
||||
- Maintenez une couverture > 80%
|
||||
- Utilisez des données de test réalistes
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### Mise à Jour de la Documentation
|
||||
|
||||
```bash
|
||||
# Structure de la documentation
|
||||
docs/
|
||||
├── INSTALLATION.md # Guide d'installation
|
||||
├── USAGE.md # Guide d'utilisation
|
||||
├── CONFIGURATION.md # Guide de configuration
|
||||
├── ARCHITECTURE.md # Architecture technique
|
||||
├── API.md # Référence API
|
||||
├── TESTING.md # Guide des tests
|
||||
└── INDEX.md # Index principal
|
||||
```
|
||||
|
||||
### Standards de Documentation
|
||||
|
||||
- Utilisez le Markdown
|
||||
- Incluez des exemples de code
|
||||
- Ajoutez des diagrammes si nécessaire
|
||||
- Maintenez la cohérence du style
|
||||
- Traduisez en anglais si possible
|
||||
|
||||
## 🐛 Signaler un Bug
|
||||
|
||||
### Template de Bug Report
|
||||
|
||||
```markdown
|
||||
## Description du Bug
|
||||
|
||||
Description claire et concise du problème.
|
||||
|
||||
## Étapes pour Reproduire
|
||||
|
||||
1. Aller à '...'
|
||||
2. Cliquer sur '...'
|
||||
3. Faire défiler jusqu'à '...'
|
||||
4. Voir l'erreur
|
||||
|
||||
## Comportement Attendu
|
||||
|
||||
Description de ce qui devrait se passer.
|
||||
|
||||
## Comportement Actuel
|
||||
|
||||
Description de ce qui se passe actuellement.
|
||||
|
||||
## Informations Système
|
||||
|
||||
- OS: [ex: Ubuntu 20.04]
|
||||
- Docker: [ex: 20.10.0]
|
||||
- Version: [ex: v1.0.0]
|
||||
|
||||
## Logs
|
||||
|
||||
```
|
||||
Logs pertinents ici
|
||||
```
|
||||
|
||||
## Capture d'Écran
|
||||
|
||||
Si applicable, ajoutez une capture d'écran.
|
||||
|
||||
## Contexte Supplémentaire
|
||||
|
||||
Toute autre information pertinente.
|
||||
```
|
||||
|
||||
## 💡 Proposer une Fonctionnalité
|
||||
|
||||
### Template de Feature Request
|
||||
|
||||
```markdown
|
||||
## Résumé
|
||||
|
||||
Description claire et concise de la fonctionnalité souhaitée.
|
||||
|
||||
## Motivation
|
||||
|
||||
Pourquoi cette fonctionnalité est-elle nécessaire ?
|
||||
|
||||
## Proposition
|
||||
|
||||
Description détaillée de la fonctionnalité proposée.
|
||||
|
||||
## Alternatives Considérées
|
||||
|
||||
Autres solutions envisagées.
|
||||
|
||||
## Impact
|
||||
|
||||
Impact sur les utilisateurs et l'architecture.
|
||||
|
||||
## Exemples d'Utilisation
|
||||
|
||||
Comment cette fonctionnalité serait-elle utilisée ?
|
||||
```
|
||||
|
||||
## 🔍 Code Review
|
||||
|
||||
### Processus de Review
|
||||
|
||||
1. **Automatique** - Tests et linting
|
||||
2. **Review par l'équipe** - Code review manuel
|
||||
3. **Tests d'intégration** - Validation complète
|
||||
4. **Approbation** - Merge dans main
|
||||
|
||||
### Critères de Review
|
||||
|
||||
- [ ] Code fonctionnel et testé
|
||||
- [ ] Tests ajoutés/modifiés
|
||||
- [ ] Documentation mise à jour
|
||||
- [ ] Pas de régression
|
||||
- [ ] Performance acceptable
|
||||
- [ ] Sécurité vérifiée
|
||||
|
||||
### Répondre aux Reviews
|
||||
|
||||
- Répondez poliment aux commentaires
|
||||
- Apportez les modifications demandées
|
||||
- Demandez des clarifications si nécessaire
|
||||
- Re-merguez après les corrections
|
||||
|
||||
## 📦 Release
|
||||
|
||||
### Processus de Release
|
||||
|
||||
1. **Préparation** - Finaliser les fonctionnalités
|
||||
2. **Tests** - Tests complets
|
||||
3. **Documentation** - Mise à jour des docs
|
||||
4. **Tag** - Créer un tag de version
|
||||
5. **Release** - Publier sur GitHub/GitLab
|
||||
6. **Annonce** - Communiquer la release
|
||||
|
||||
### Numérotation des Versions
|
||||
|
||||
Utilisez le [Semantic Versioning](https://semver.org/) :
|
||||
|
||||
- **MAJOR** - Changements incompatibles
|
||||
- **MINOR** - Nouvelles fonctionnalités compatibles
|
||||
- **PATCH** - Corrections de bugs compatibles
|
||||
|
||||
## 🤝 Communauté
|
||||
|
||||
### Communication
|
||||
|
||||
- **Issues** - Pour les bugs et fonctionnalités
|
||||
- **Discussions** - Pour les questions générales (via les issues)
|
||||
- **Pull Requests** - Pour les contributions
|
||||
- **Wiki** - Pour la documentation collaborative (si activé sur Gitea)
|
||||
|
||||
### Code de Conduite
|
||||
|
||||
- Soyez respectueux et inclusif
|
||||
- Écoutez les autres points de vue
|
||||
- Contribuez de manière constructive
|
||||
- Respectez les standards du projet
|
||||
|
||||
### Reconnaissance
|
||||
|
||||
- Les contributeurs sont listés dans le README
|
||||
- Les contributions significatives sont reconnues
|
||||
- Les releases mentionnent les contributeurs
|
||||
|
||||
## 🆘 Besoin d'Aide ?
|
||||
|
||||
- Consultez la [documentation](docs/)
|
||||
- Vérifiez les [issues existantes](https://git.4nkweb.com/4nk/4NK_node/issues)
|
||||
- Posez une question via les [issues](https://git.4nkweb.com/4nk/4NK_node/issues/new)
|
||||
- Contactez l'équipe de maintenance
|
||||
|
||||
## 📄 Licence
|
||||
|
||||
En contribuant, vous acceptez que vos contributions soient sous la même licence que le projet (MIT).
|
||||
|
||||
---
|
||||
|
||||
Merci de contribuer à 4NK Node ! 🚀
|
||||
38
Cargo.toml
38
Cargo.toml
@ -6,30 +6,18 @@ edition = "2021"
|
||||
[lib]
|
||||
crate-type = ["cdylib", "rlib"]
|
||||
|
||||
[features]
|
||||
default = []
|
||||
parallel = ["sp-client/parallel"]
|
||||
blindbit-backend = ["backend-blindbit-native"]
|
||||
blindbit-wasm = ["backend-blindbit-wasm", "dep:js-sys", "dep:serde-wasm-bindgen"]
|
||||
|
||||
[dependencies]
|
||||
aes-gcm = "0.10.3"
|
||||
anyhow = "1.0"
|
||||
env_logger = "0.9"
|
||||
log = "0.4.6"
|
||||
rand = "0.8.5"
|
||||
wasm-bindgen = "0.2.90"
|
||||
serde = { version = "1.0.193", features = ["derive"] }
|
||||
serde_json = { version = "1.0.108" }
|
||||
rs_merkle = "1.4.2"
|
||||
zstd = "0.13.3"
|
||||
getrandom = { version = "0.2", features = ["js"] }
|
||||
sp-client = { git = "https://github.com/Sosthene00/sp-client.git", branch = "dev", default-features = false }
|
||||
backend-blindbit-native = { git = "https://github.com/Sosthene00/sp-client.git", branch = "dev", optional = true }
|
||||
backend-blindbit-wasm = { git = "https://github.com/Sosthene00/sp-client.git", branch = "dev", optional = true }
|
||||
tsify = { git = "https://github.com/Sosthene00/tsify", branch = "next" }
|
||||
wasm-bindgen = "0.2.91"
|
||||
|
||||
# WASM-specific dependencies (optional)
|
||||
js-sys = { version = "0.3.69", optional = true }
|
||||
serde-wasm-bindgen = { version = "0.6.5", optional = true }
|
||||
|
||||
serde_json = "1.0.108"
|
||||
# sp_backend = { git = "https://github.com/Sosthene00/sp-backend.git", branch = "master" }
|
||||
# silentPayments = { git = "https://github.com/Sosthene00/rust-silentPayments", branch = "utils" }
|
||||
rand = "0.8.5"
|
||||
hex = "0.4.3"
|
||||
uuid = { version = "1.6.1", features = ["serde", "v4"] }
|
||||
sha2 = "0.10.8"
|
||||
chrono = "0.4.31"
|
||||
aes-gcm = "0.10.3"
|
||||
aes = "0.8.3"
|
||||
base64 = "0.21.7"
|
||||
rocket = { version = "0.5.0", features = ["json"] }
|
||||
|
||||
21
LICENSE
21
LICENSE
@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 4NK Team
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
232
SECURITY.md
232
SECURITY.md
@ -1,232 +0,0 @@
|
||||
# Politique de Sécurité - 4NK Node
|
||||
|
||||
## 🛡️ Signalement de Vulnérabilités
|
||||
|
||||
Nous prenons la sécurité très au sérieux. Si vous découvrez une vulnérabilité de sécurité, nous vous demandons de la signaler de manière responsable.
|
||||
|
||||
### Comment Signaler une Vulnérabilité
|
||||
|
||||
**NE PAS** créer d'issue publique pour les vulnérabilités de sécurité.
|
||||
|
||||
**À la place :**
|
||||
1. Envoyez un email à [security@4nkweb.com](mailto:security@4nkweb.com)
|
||||
2. Incluez "SECURITY VULNERABILITY" dans l'objet
|
||||
3. Décrivez la vulnérabilité de manière détaillée
|
||||
4. Incluez les étapes pour reproduire le problème
|
||||
5. Proposez une solution si possible
|
||||
|
||||
### Ce que nous attendons
|
||||
|
||||
- **Confidentialité** : Ne divulguez pas la vulnérabilité publiquement
|
||||
- **Détails** : Fournissez suffisamment d'informations pour reproduire le problème
|
||||
- **Patience** : Nous examinerons et répondrons dans les 48h
|
||||
- **Coopération** : Nous pouvons avoir besoin de clarifications
|
||||
|
||||
### Ce que vous pouvez attendre
|
||||
|
||||
- **Réponse rapide** : Accusé de réception dans les 48h
|
||||
- **Évaluation** : Analyse de la vulnérabilité
|
||||
- **Mise à jour** : Statut de la correction
|
||||
- **Reconnaissance** : Mention dans les remerciements (si souhaité)
|
||||
|
||||
## 🔒 Bonnes Pratiques de Sécurité
|
||||
|
||||
### Pour les Contributeurs
|
||||
|
||||
#### Code
|
||||
- Validez toutes les entrées utilisateur
|
||||
- Utilisez des requêtes préparées pour les bases de données
|
||||
- Évitez les injections de code
|
||||
- Implémentez l'authentification appropriée
|
||||
- Utilisez HTTPS pour toutes les communications
|
||||
|
||||
#### Configuration
|
||||
- Ne committez jamais de secrets
|
||||
- Utilisez des variables d'environnement pour les données sensibles
|
||||
- Vérifiez les permissions des fichiers
|
||||
- Maintenez les dépendances à jour
|
||||
|
||||
#### Tests
|
||||
- Incluez des tests de sécurité
|
||||
- Testez les cas limites
|
||||
- Validez les entrées malveillantes
|
||||
- Vérifiez les fuites de mémoire
|
||||
|
||||
### Pour les Utilisateurs
|
||||
|
||||
#### Installation
|
||||
- Utilisez des sources officielles
|
||||
- Vérifiez les checksums
|
||||
- Maintenez le système à jour
|
||||
- Utilisez un pare-feu
|
||||
|
||||
#### Configuration
|
||||
- Changez les mots de passe par défaut
|
||||
- Utilisez des clés SSH fortes
|
||||
- Limitez l'accès réseau
|
||||
- Surveillez les logs
|
||||
|
||||
#### Opération
|
||||
- Surveillez les connexions
|
||||
- Sauvegardez régulièrement
|
||||
- Testez les sauvegardes
|
||||
- Documentez les incidents
|
||||
|
||||
## 🔍 Audit de Sécurité
|
||||
|
||||
### Composants Principaux
|
||||
|
||||
#### Bitcoin Core
|
||||
- **RPC Interface** : Authentification requise
|
||||
- **ZMQ** : Communication locale uniquement
|
||||
- **P2P** : Validation des blocs
|
||||
- **Wallet** : Chiffrement des clés
|
||||
|
||||
#### Blindbit
|
||||
- **API HTTP** : Validation des entrées
|
||||
- **Filtres** : Vérification des signatures
|
||||
- **Cache** : Protection contre les attaques DoS
|
||||
- **Logs** : Pas d'informations sensibles
|
||||
|
||||
#### SDK Relay
|
||||
- **WebSocket** : Validation des messages
|
||||
- **Synchronisation** : Authentification des pairs
|
||||
- **Cache** : Protection contre les attaques
|
||||
- **Configuration** : Validation des paramètres
|
||||
|
||||
#### Tor
|
||||
- **Proxy** : Configuration sécurisée
|
||||
- **Contrôle** : Accès restreint
|
||||
- **Logs** : Anonymisation
|
||||
- **Mise à jour** : Versions récentes
|
||||
|
||||
### Tests de Sécurité
|
||||
|
||||
#### Tests Automatisés
|
||||
```bash
|
||||
# Tests de sécurité
|
||||
./tests/run_security_tests.sh
|
||||
|
||||
# Vérification des vulnérabilités
|
||||
./tests/check_vulnerabilities.sh
|
||||
|
||||
# Audit des dépendances
|
||||
./tests/audit_dependencies.sh
|
||||
```
|
||||
|
||||
#### Tests Manuels
|
||||
- Tests de pénétration
|
||||
- Audit de code
|
||||
- Tests de configuration
|
||||
- Tests de performance sous charge
|
||||
|
||||
## 🚨 Réponse aux Incidents
|
||||
|
||||
### Procédure d'Urgence
|
||||
|
||||
1. **Détection** : Identifier l'incident
|
||||
2. **Containment** : Limiter l'impact
|
||||
3. **Éradication** : Supprimer la cause
|
||||
4. **Récupération** : Restaurer les services
|
||||
5. **Post-mortem** : Analyser et améliorer
|
||||
|
||||
### Communication
|
||||
|
||||
- **Interne** : Équipe de sécurité
|
||||
- **Utilisateurs** : Notification appropriée
|
||||
- **Communauté** : Disclosure responsable
|
||||
- **Autorités** : Si nécessaire
|
||||
|
||||
### Documentation
|
||||
|
||||
- **Incident Report** : Détails de l'incident
|
||||
- **Timeline** : Chronologie des événements
|
||||
- **Actions** : Mesures prises
|
||||
- **Lessons Learned** : Améliorations
|
||||
|
||||
## 📋 Checklist de Sécurité
|
||||
|
||||
### Avant le Déploiement
|
||||
- [ ] Audit de code de sécurité
|
||||
- [ ] Tests de vulnérabilités
|
||||
- [ ] Vérification des dépendances
|
||||
- [ ] Configuration sécurisée
|
||||
- [ ] Tests de charge
|
||||
|
||||
### Pendant l'Opération
|
||||
- [ ] Monitoring de sécurité
|
||||
- [ ] Surveillance des logs
|
||||
- [ ] Mise à jour des composants
|
||||
- [ ] Sauvegarde des données
|
||||
- [ ] Tests de récupération
|
||||
|
||||
### Après un Incident
|
||||
- [ ] Analyse post-mortem
|
||||
- [ ] Mise à jour des procédures
|
||||
- [ ] Formation de l'équipe
|
||||
- [ ] Amélioration des outils
|
||||
- [ ] Communication à la communauté
|
||||
|
||||
## 🔧 Outils de Sécurité
|
||||
|
||||
### Monitoring
|
||||
- **Logs** : Centralisation et analyse
|
||||
- **Métriques** : Surveillance en temps réel
|
||||
- **Alertes** : Notification automatique
|
||||
- **Tableaux de bord** : Vue d'ensemble
|
||||
|
||||
### Tests
|
||||
- **SAST** : Analyse statique
|
||||
- **DAST** : Tests dynamiques
|
||||
- **IAST** : Tests interactifs
|
||||
- **Fuzzing** : Tests de robustesse
|
||||
|
||||
### Protection
|
||||
- **WAF** : Pare-feu applicatif
|
||||
- **IDS/IPS** : Détection d'intrusion
|
||||
- **Antivirus** : Protection des endpoints
|
||||
- **Chiffrement** : Protection des données
|
||||
|
||||
## 📚 Ressources
|
||||
|
||||
### Documentation
|
||||
- [Guide de Sécurité Bitcoin](https://bitcoin.org/en/security)
|
||||
- [OWASP Top 10](https://owasp.org/www-project-top-ten/)
|
||||
- [CWE/SANS Top 25](https://cwe.mitre.org/top25/)
|
||||
- [NIST Cybersecurity Framework](https://www.nist.gov/cyberframework)
|
||||
|
||||
### Outils
|
||||
- [Bandit](https://bandit.readthedocs.io/) - Analyse Python
|
||||
- [Clang Static Analyzer](https://clang-analyzer.llvm.org/) - Analyse C/C++
|
||||
- [SonarQube](https://www.sonarqube.org/) - Qualité du code
|
||||
- [OpenVAS](https://www.openvas.org/) - Scan de vulnérabilités
|
||||
|
||||
### Formation
|
||||
- Cours de sécurité applicative
|
||||
- Formation aux tests de pénétration
|
||||
- Certification en cybersécurité
|
||||
- Participation à des CTF
|
||||
|
||||
## 🤝 Collaboration
|
||||
|
||||
### Bug Bounty
|
||||
- Programme de récompenses pour les vulnérabilités
|
||||
- Critères d'éligibilité
|
||||
- Montants des récompenses
|
||||
- Processus de validation
|
||||
|
||||
### Responsible Disclosure
|
||||
- Timeline de divulgation
|
||||
- Coordination avec les chercheurs
|
||||
- Communication publique
|
||||
- Remerciements
|
||||
|
||||
### Communauté
|
||||
- Groupe de sécurité
|
||||
- Discussions techniques
|
||||
- Partage d'informations
|
||||
- Collaboration avec d'autres projets
|
||||
|
||||
---
|
||||
|
||||
**La sécurité est une responsabilité partagée. Merci de contribuer à maintenir 4NK Node sécurisé !** 🔒
|
||||
@ -1,236 +0,0 @@
|
||||
# Automatisation SSH pour Push - ihm_client
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
L'automatisation SSH pour les push permet d'utiliser automatiquement votre clé SSH pour tous les push vers le repository `ihm_client` sur Gitea, sans avoir à spécifier manuellement les paramètres SSH.
|
||||
|
||||
## Configuration automatique
|
||||
|
||||
### 1. Configuration Git globale
|
||||
|
||||
La configuration SSH est automatiquement appliquée :
|
||||
|
||||
```bash
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### 2. Vérification SSH
|
||||
|
||||
Le script vérifie automatiquement la configuration SSH :
|
||||
|
||||
```bash
|
||||
ssh -T git@git.4nkweb.com
|
||||
```
|
||||
|
||||
## Scripts d'automatisation
|
||||
|
||||
### Script principal : `auto-ssh-push.sh`
|
||||
|
||||
Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique :
|
||||
|
||||
#### Options disponibles
|
||||
|
||||
```bash
|
||||
# Push rapide (message automatique)
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Push avec message personnalisé
|
||||
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"
|
||||
|
||||
# Push sur une branche spécifique
|
||||
./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite
|
||||
|
||||
# Push et préparation merge
|
||||
./scripts/auto-ssh-push.sh merge feature/nouvelle-fonctionnalite main
|
||||
|
||||
# Status et push conditionnel
|
||||
./scripts/auto-ssh-push.sh status
|
||||
```
|
||||
|
||||
#### Exemples d'utilisation
|
||||
|
||||
```bash
|
||||
# Push rapide sur la branche courante
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Push avec message de commit
|
||||
./scripts/auto-ssh-push.sh message "fix: correction du bug de synchronisation"
|
||||
|
||||
# Push sur une branche spécifique
|
||||
./scripts/auto-ssh-push.sh branch develop
|
||||
|
||||
# Push et création de Pull Request
|
||||
./scripts/auto-ssh-push.sh merge feature/nouvelle-fonctionnalite main
|
||||
```
|
||||
|
||||
### Alias Git globaux
|
||||
|
||||
Des alias Git ont été configurés pour simplifier les push :
|
||||
|
||||
```bash
|
||||
# Push avec message personnalisé
|
||||
git ssh-push "Mon message de commit"
|
||||
|
||||
# Push rapide (message automatique)
|
||||
git quick-push
|
||||
```
|
||||
|
||||
## Fonctionnalités automatiques
|
||||
|
||||
### 1. Configuration SSH automatique
|
||||
|
||||
- Configuration Git pour utiliser SSH
|
||||
- Vérification de l'authentification SSH
|
||||
- Gestion des erreurs de configuration
|
||||
|
||||
### 2. Push automatique
|
||||
|
||||
- Ajout automatique de tous les changements (`git add .`)
|
||||
- Commit automatique avec message
|
||||
- Push automatique vers la branche courante
|
||||
|
||||
### 3. Gestion des branches
|
||||
|
||||
- Détection automatique de la branche courante
|
||||
- Support des branches personnalisées
|
||||
- Préparation des Pull Requests
|
||||
|
||||
### 4. Validation et sécurité
|
||||
|
||||
- Vérification de l'authentification SSH avant push
|
||||
- Messages d'erreur explicites
|
||||
- Gestion des cas d'échec
|
||||
|
||||
## Workflow recommandé
|
||||
|
||||
### Développement quotidien
|
||||
|
||||
```bash
|
||||
# 1. Faire vos modifications
|
||||
# 2. Push rapide
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Ou avec message personnalisé
|
||||
./scripts/auto-ssh-push.sh message "feat: ajout de la fonctionnalité X"
|
||||
```
|
||||
|
||||
### Développement de fonctionnalités
|
||||
|
||||
```bash
|
||||
# 1. Créer une branche
|
||||
git checkout -b feature/nouvelle-fonctionnalite
|
||||
|
||||
# 2. Développer
|
||||
# 3. Push sur la branche
|
||||
./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite
|
||||
|
||||
# 4. Préparer le merge
|
||||
./scripts/auto-ssh-push.sh merge feature/nouvelle-fonctionnalite main
|
||||
```
|
||||
|
||||
### Intégration continue
|
||||
|
||||
```bash
|
||||
# Push automatique après tests
|
||||
./scripts/auto-ssh-push.sh message "ci: tests passés, déploiement automatique"
|
||||
```
|
||||
|
||||
## Dépannage
|
||||
|
||||
### Problèmes courants
|
||||
|
||||
#### 1. Échec d'authentification SSH
|
||||
|
||||
```bash
|
||||
# Vérifier la clé SSH
|
||||
ssh -T git@git.4nkweb.com
|
||||
|
||||
# Si échec, configurer une nouvelle clé
|
||||
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk
|
||||
ssh-add ~/.ssh/id_ed25519_4nk
|
||||
```
|
||||
|
||||
#### 2. Configuration Git manquante
|
||||
|
||||
```bash
|
||||
# Reconfigurer Git pour SSH
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
#### 3. Permissions de script
|
||||
|
||||
```bash
|
||||
# Rendre le script exécutable
|
||||
chmod +x scripts/auto-ssh-push.sh
|
||||
```
|
||||
|
||||
### Commandes de diagnostic
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration SSH
|
||||
ssh -vT git@git.4nkweb.com
|
||||
|
||||
# Vérifier la configuration Git
|
||||
git config --global --list | grep url
|
||||
|
||||
# Vérifier les remotes
|
||||
git remote -v
|
||||
```
|
||||
|
||||
## Intégration avec CI/CD
|
||||
|
||||
### Workflow Gitea Actions
|
||||
|
||||
Le workflow CI/CD (`.gitea/workflows/ci.yml`) utilise automatiquement SSH :
|
||||
|
||||
```yaml
|
||||
- name: Setup SSH for Gitea
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H git.4nkweb.com >> ~/.ssh/known_hosts
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### Variables d'environnement
|
||||
|
||||
- `SSH_PRIVATE_KEY` : Clé SSH privée pour l'authentification
|
||||
- `SSH_PUBLIC_KEY` : Clé SSH publique (optionnelle)
|
||||
|
||||
## Sécurité
|
||||
|
||||
### Bonnes pratiques
|
||||
|
||||
- Les clés SSH sont stockées de manière sécurisée
|
||||
- Les permissions des fichiers SSH sont correctement configurées
|
||||
- La vérification des hôtes SSH est activée
|
||||
- Les clés sont régulièrement renouvelées
|
||||
|
||||
### Permissions recommandées
|
||||
|
||||
```bash
|
||||
chmod 700 ~/.ssh
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
chmod 600 ~/.ssh/config
|
||||
```
|
||||
|
||||
## Évolution
|
||||
|
||||
### Améliorations futures
|
||||
|
||||
- Support pour plusieurs clés SSH
|
||||
- Rotation automatique des clés
|
||||
- Intégration avec un gestionnaire de secrets
|
||||
- Support pour l'authentification par certificats SSH
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Vérification régulière de la validité des clés SSH
|
||||
- Mise à jour des configurations selon les bonnes pratiques
|
||||
- Documentation des changements de configuration
|
||||
|
||||
## Conclusion
|
||||
|
||||
L'automatisation SSH pour les push simplifie considérablement le workflow de développement en éliminant la nécessité de configurer manuellement SSH pour chaque opération Git. Le script `auto-ssh-push.sh` et les alias Git offrent une interface simple et sécurisée pour tous les push vers le repository `ihm_client`.
|
||||
@ -1,378 +0,0 @@
|
||||
# 🔄 Guide de Migration - Documentation 4NK Node
|
||||
|
||||
Guide pour migrer et organiser la documentation existante vers la nouvelle structure.
|
||||
|
||||
## 📋 État Actuel
|
||||
|
||||
### Fichiers de Documentation Existants
|
||||
|
||||
#### Documentation Principale
|
||||
- `README.md` - Documentation principale (mis à jour)
|
||||
- `EXEMPLES_PRATIQUES.md` - Exemples d'utilisation (à migrer)
|
||||
|
||||
#### Documentation Technique
|
||||
- `specs/spec-technique.md` - Spécification technique (à conserver)
|
||||
- `specs/spec-fonctionnel.md` - Spécification fonctionnelle (à conserver)
|
||||
- `specs/spec-technical.md` - Spécification technique (à fusionner)
|
||||
|
||||
#### Documentation de Configuration
|
||||
- `CONFIGURATION_DEV3.md` - Configuration dev3.4nkweb.com (à migrer)
|
||||
- `INTEGRATION_DEV3_FINAL.md` - Intégration dev3.4nkweb.com (à migrer)
|
||||
|
||||
#### Documentation de Processus
|
||||
- `COMMANDES_REDEMARRAGE.md` - Commandes de redémarrage (à migrer)
|
||||
- `RESUME_AJOUT_DEV3.md` - Résumé ajout dev3 (à migrer)
|
||||
- `RESUME_DECOUVERTE_NOEUDS.md` - Découverte des nœuds (à migrer)
|
||||
- `RESUME_SCRIPT_RESTART.md` - Script de redémarrage (à migrer)
|
||||
- `RESUME_TEST_3_RELAIS.md` - Test 3 relais (à migrer)
|
||||
|
||||
#### Documentation de Scripts
|
||||
- `README_RESTART_SCRIPT.md` - Documentation script redémarrage (à migrer)
|
||||
- `explain_node_discovery.md` - Explication découverte nœuds (à migrer)
|
||||
|
||||
## 🎯 Plan de Migration
|
||||
|
||||
### 1. Structure de Documentation
|
||||
|
||||
```
|
||||
4NK_node/
|
||||
├── README.md # ✅ Mis à jour
|
||||
├── docs/ # ✅ Nouvelle structure
|
||||
│ ├── INDEX.md # ✅ Créé
|
||||
│ ├── INSTALLATION.md # ✅ Créé
|
||||
│ ├── USAGE.md # ✅ Créé
|
||||
│ ├── CONFIGURATION.md # ✅ Créé
|
||||
│ ├── QUICK_REFERENCE.md # ✅ Créé
|
||||
│ ├── MIGRATION.md # ✅ Ce fichier
|
||||
│ ├── ARCHITECTURE.md # 🔄 À créer
|
||||
│ ├── API.md # 🔄 À créer
|
||||
│ ├── SECURITY.md # 🔄 À créer
|
||||
│ ├── PERFORMANCE.md # 🔄 À créer
|
||||
│ ├── TESTING.md # 🔄 À créer
|
||||
│ ├── SYNC_TESTING.md # 🔄 À créer
|
||||
│ ├── PERFORMANCE_TESTING.md # 🔄 À créer
|
||||
│ ├── RELAY_NETWORK.md # 🔄 À créer
|
||||
│ ├── EXTERNAL_NODES.md # 🔄 À créer
|
||||
│ ├── SYNCHRONIZATION.md # 🔄 À créer
|
||||
│ ├── TROUBLESHOOTING.md # 🔄 À créer
|
||||
│ └── FAQ.md # 🔄 À créer
|
||||
├── specs/ # ✅ À conserver
|
||||
│ ├── spec-technique.md # ✅ Conserver
|
||||
│ └── spec-fonctionnel.md # ✅ Conserver
|
||||
├── archive/ # 🔄 À créer
|
||||
│ ├── docs/ # 🔄 Anciens fichiers
|
||||
│ └── README.md # 🔄 Documentation archive
|
||||
└── examples/ # 🔄 À créer
|
||||
├── configuration/ # 🔄 Exemples de config
|
||||
├── scripts/ # 🔄 Scripts d'exemple
|
||||
└── tests/ # 🔄 Tests d'exemple
|
||||
```
|
||||
|
||||
### 2. Migration des Fichiers
|
||||
|
||||
#### Fichiers à Migrer vers `docs/`
|
||||
|
||||
| Fichier Source | Destination | Statut |
|
||||
|----------------|-------------|---------|
|
||||
| `EXEMPLES_PRATIQUES.md` | `docs/USAGE.md` | ✅ Intégré |
|
||||
| `CONFIGURATION_DEV3.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
||||
| `INTEGRATION_DEV3_FINAL.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
||||
| `COMMANDES_REDEMARRAGE.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
||||
| `RESUME_AJOUT_DEV3.md` | `docs/EXTERNAL_NODES.md` | 🔄 À migrer |
|
||||
| `RESUME_DECOUVERTE_NOEUDS.md` | `docs/RELAY_NETWORK.md` | 🔄 À migrer |
|
||||
| `RESUME_SCRIPT_RESTART.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
||||
| `RESUME_TEST_3_RELAIS.md` | `docs/SYNC_TESTING.md` | 🔄 À migrer |
|
||||
| `README_RESTART_SCRIPT.md` | `docs/QUICK_REFERENCE.md` | ✅ Intégré |
|
||||
| `explain_node_discovery.md` | `docs/RELAY_NETWORK.md` | 🔄 À migrer |
|
||||
|
||||
#### Fichiers à Conserver
|
||||
|
||||
| Fichier | Raison | Action |
|
||||
|---------|--------|---------|
|
||||
| `specs/spec-technique.md` | Documentation technique détaillée | ✅ Conserver |
|
||||
| `specs/spec-fonctionnel.md` | Spécification fonctionnelle | ✅ Conserver |
|
||||
| `specs/spec-technical.md` | Spécification technique | 🔄 Fusionner avec spec-technique.md |
|
||||
|
||||
#### Fichiers à Archiver
|
||||
|
||||
| Fichier | Action |
|
||||
|---------|--------|
|
||||
| `EXEMPLES_PRATIQUES.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `CONFIGURATION_DEV3.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `INTEGRATION_DEV3_FINAL.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `COMMANDES_REDEMARRAGE.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `RESUME_AJOUT_DEV3.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `RESUME_DECOUVERTE_NOEUDS.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `RESUME_SCRIPT_RESTART.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `RESUME_TEST_3_RELAIS.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `README_RESTART_SCRIPT.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
| `explain_node_discovery.md` | 🔄 Déplacer vers `archive/docs/` |
|
||||
|
||||
## 🔄 Processus de Migration
|
||||
|
||||
### Étape 1 : Créer la Structure
|
||||
|
||||
```bash
|
||||
# Créer les dossiers
|
||||
mkdir -p docs archive/docs examples/{configuration,scripts,tests}
|
||||
|
||||
# Créer le README de l'archive
|
||||
cat > archive/README.md << 'EOF'
|
||||
# 📦 Archive - Documentation 4NK Node
|
||||
|
||||
Ce dossier contient les anciens fichiers de documentation qui ont été migrés vers la nouvelle structure organisée.
|
||||
|
||||
## 📁 Contenu
|
||||
|
||||
- `docs/` - Anciens fichiers de documentation
|
||||
- `README.md` - Ce fichier
|
||||
|
||||
## 🔗 Liens vers la Nouvelle Documentation
|
||||
|
||||
- **Documentation principale** : [../docs/INDEX.md](../docs/INDEX.md)
|
||||
- **Guide d'installation** : [../docs/INSTALLATION.md](../docs/INSTALLATION.md)
|
||||
- **Guide d'utilisation** : [../docs/USAGE.md](../docs/USAGE.md)
|
||||
- **Guide de configuration** : [../docs/CONFIGURATION.md](../docs/CONFIGURATION.md)
|
||||
- **Référence rapide** : [../docs/QUICK_REFERENCE.md](../docs/QUICK_REFERENCE.md)
|
||||
|
||||
## 📅 Date de Migration
|
||||
|
||||
Migration effectuée le : $(date)
|
||||
EOF
|
||||
```
|
||||
|
||||
### Étape 2 : Migrer les Fichiers
|
||||
|
||||
```bash
|
||||
# Déplacer les fichiers vers l'archive
|
||||
mv EXEMPLES_PRATIQUES.md archive/docs/
|
||||
mv CONFIGURATION_DEV3.md archive/docs/
|
||||
mv INTEGRATION_DEV3_FINAL.md archive/docs/
|
||||
mv COMMANDES_REDEMARRAGE.md archive/docs/
|
||||
mv RESUME_AJOUT_DEV3.md archive/docs/
|
||||
mv RESUME_DECOUVERTE_NOEUDS.md archive/docs/
|
||||
mv RESUME_SCRIPT_RESTART.md archive/docs/
|
||||
mv RESUME_TEST_3_RELAIS.md archive/docs/
|
||||
mv README_RESTART_SCRIPT.md archive/docs/
|
||||
mv explain_node_discovery.md archive/docs/
|
||||
```
|
||||
|
||||
### Étape 3 : Fusionner les Spécifications
|
||||
|
||||
```bash
|
||||
# Fusionner spec-technical.md dans spec-technique.md
|
||||
cat specs/spec-technical.md >> specs/spec-technique.md
|
||||
|
||||
# Supprimer le fichier fusionné
|
||||
rm specs/spec-technical.md
|
||||
```
|
||||
|
||||
### Étape 4 : Créer les Guides Manquants
|
||||
|
||||
#### Créer `docs/ARCHITECTURE.md`
|
||||
```bash
|
||||
# Extraire les sections architecture de spec-technique.md
|
||||
grep -A 50 "Architecture" specs/spec-technique.md > docs/ARCHITECTURE.md
|
||||
```
|
||||
|
||||
#### Créer `docs/EXTERNAL_NODES.md`
|
||||
```bash
|
||||
# Combiner les fichiers de configuration externe
|
||||
cat archive/docs/CONFIGURATION_DEV3.md archive/docs/INTEGRATION_DEV3_FINAL.md archive/docs/RESUME_AJOUT_DEV3.md > docs/EXTERNAL_NODES.md
|
||||
```
|
||||
|
||||
#### Créer `docs/RELAY_NETWORK.md`
|
||||
```bash
|
||||
# Combiner les fichiers de réseau de relais
|
||||
cat archive/docs/RESUME_DECOUVERTE_NOEUDS.md archive/docs/explain_node_discovery.md > docs/RELAY_NETWORK.md
|
||||
```
|
||||
|
||||
#### Créer `docs/SYNC_TESTING.md`
|
||||
```bash
|
||||
# Extraire les sections de test de synchronisation
|
||||
cat archive/docs/RESUME_TEST_3_RELAIS.md > docs/SYNC_TESTING.md
|
||||
```
|
||||
|
||||
### Étape 5 : Créer les Exemples
|
||||
|
||||
```bash
|
||||
# Créer des exemples de configuration
|
||||
cat > examples/configuration/bitcoin.conf.example << 'EOF'
|
||||
# Exemple de configuration Bitcoin Core
|
||||
signet=1
|
||||
rpcuser=bitcoin
|
||||
rpcpassword=your_secure_password
|
||||
rpcbind=0.0.0.0
|
||||
rpcallowip=172.19.0.0/16
|
||||
zmqpubrawblock=tcp://0.0.0.0:29000
|
||||
zmqpubrawtx=tcp://0.0.0.0:29000
|
||||
txindex=1
|
||||
server=1
|
||||
listen=1
|
||||
EOF
|
||||
|
||||
# Créer des exemples de scripts
|
||||
cat > examples/scripts/monitor.sh << 'EOF'
|
||||
#!/bin/bash
|
||||
# Exemple de script de monitoring
|
||||
while true; do
|
||||
echo "=== $(date) ==="
|
||||
docker ps --format "table {{.Names}}\t{{.Status}}"
|
||||
sleep 30
|
||||
done
|
||||
EOF
|
||||
|
||||
chmod +x examples/scripts/monitor.sh
|
||||
```
|
||||
|
||||
## 📋 Checklist de Migration
|
||||
|
||||
### ✅ Fichiers Créés
|
||||
- [x] `docs/INDEX.md` - Index de documentation
|
||||
- [x] `docs/INSTALLATION.md` - Guide d'installation
|
||||
- [x] `docs/USAGE.md` - Guide d'utilisation
|
||||
- [x] `docs/CONFIGURATION.md` - Guide de configuration
|
||||
- [x] `docs/QUICK_REFERENCE.md` - Référence rapide
|
||||
- [x] `docs/MIGRATION.md` - Ce guide de migration
|
||||
|
||||
### 🔄 Fichiers à Créer
|
||||
- [ ] `docs/ARCHITECTURE.md` - Architecture technique
|
||||
- [ ] `docs/API.md` - Référence API
|
||||
- [ ] `docs/SECURITY.md` - Guide de sécurité
|
||||
- [ ] `docs/PERFORMANCE.md` - Guide de performance
|
||||
- [ ] `docs/TESTING.md` - Tests de base
|
||||
- [ ] `docs/SYNC_TESTING.md` - Tests de synchronisation
|
||||
- [ ] `docs/PERFORMANCE_TESTING.md` - Tests de performance
|
||||
- [ ] `docs/RELAY_NETWORK.md` - Réseau de relais
|
||||
- [ ] `docs/EXTERNAL_NODES.md` - Nœuds externes
|
||||
- [ ] `docs/SYNCHRONIZATION.md` - Protocole de synchronisation
|
||||
- [ ] `docs/TROUBLESHOOTING.md` - Guide de dépannage
|
||||
- [ ] `docs/FAQ.md` - Questions fréquentes
|
||||
|
||||
### 🔄 Fichiers à Migrer
|
||||
- [ ] `EXEMPLES_PRATIQUES.md` → `archive/docs/`
|
||||
- [ ] `CONFIGURATION_DEV3.md` → `archive/docs/`
|
||||
- [ ] `INTEGRATION_DEV3_FINAL.md` → `archive/docs/`
|
||||
- [ ] `COMMANDES_REDEMARRAGE.md` → `archive/docs/`
|
||||
- [ ] `RESUME_AJOUT_DEV3.md` → `archive/docs/`
|
||||
- [ ] `RESUME_DECOUVERTE_NOEUDS.md` → `archive/docs/`
|
||||
- [ ] `RESUME_SCRIPT_RESTART.md` → `archive/docs/`
|
||||
- [ ] `RESUME_TEST_3_RELAIS.md` → `archive/docs/`
|
||||
- [ ] `README_RESTART_SCRIPT.md` → `archive/docs/`
|
||||
- [ ] `explain_node_discovery.md` → `archive/docs/`
|
||||
|
||||
### 🔄 Fichiers à Fusionner
|
||||
- [ ] `specs/spec-technical.md` → `specs/spec-technique.md`
|
||||
|
||||
### 🔄 Dossiers à Créer
|
||||
- [ ] `archive/` - Dossier d'archive
|
||||
- [ ] `archive/docs/` - Anciens fichiers de documentation
|
||||
- [ ] `examples/` - Exemples d'utilisation
|
||||
- [ ] `examples/configuration/` - Exemples de configuration
|
||||
- [ ] `examples/scripts/` - Scripts d'exemple
|
||||
- [ ] `examples/tests/` - Tests d'exemple
|
||||
|
||||
## 🎯 Résultat Final
|
||||
|
||||
### Structure Finale
|
||||
```
|
||||
4NK_node/
|
||||
├── README.md # Documentation principale
|
||||
├── docs/ # Documentation organisée
|
||||
│ ├── INDEX.md # Index de documentation
|
||||
│ ├── INSTALLATION.md # Guide d'installation
|
||||
│ ├── USAGE.md # Guide d'utilisation
|
||||
│ ├── CONFIGURATION.md # Guide de configuration
|
||||
│ ├── QUICK_REFERENCE.md # Référence rapide
|
||||
│ ├── ARCHITECTURE.md # Architecture technique
|
||||
│ ├── API.md # Référence API
|
||||
│ ├── SECURITY.md # Guide de sécurité
|
||||
│ ├── PERFORMANCE.md # Guide de performance
|
||||
│ ├── TESTING.md # Tests de base
|
||||
│ ├── SYNC_TESTING.md # Tests de synchronisation
|
||||
│ ├── PERFORMANCE_TESTING.md # Tests de performance
|
||||
│ ├── RELAY_NETWORK.md # Réseau de relais
|
||||
│ ├── EXTERNAL_NODES.md # Nœuds externes
|
||||
│ ├── SYNCHRONIZATION.md # Protocole de synchronisation
|
||||
│ ├── TROUBLESHOOTING.md # Guide de dépannage
|
||||
│ ├── FAQ.md # Questions fréquentes
|
||||
│ └── MIGRATION.md # Guide de migration
|
||||
├── specs/ # Spécifications techniques
|
||||
│ ├── spec-technique.md # Spécification technique (fusionnée)
|
||||
│ └── spec-fonctionnel.md # Spécification fonctionnelle
|
||||
├── archive/ # Archive des anciens fichiers
|
||||
│ ├── docs/ # Anciens fichiers de documentation
|
||||
│ └── README.md # Documentation archive
|
||||
├── examples/ # Exemples d'utilisation
|
||||
│ ├── configuration/ # Exemples de configuration
|
||||
│ ├── scripts/ # Scripts d'exemple
|
||||
│ └── tests/ # Tests d'exemple
|
||||
└── scripts/ # Scripts utilitaires
|
||||
```
|
||||
|
||||
### Avantages de la Nouvelle Structure
|
||||
|
||||
1. **Organisation claire** : Documentation organisée par sujet
|
||||
2. **Navigation facile** : Index centralisé avec liens
|
||||
3. **Parcours d'apprentissage** : Guides adaptés au niveau d'expertise
|
||||
4. **Maintenance simplifiée** : Structure modulaire
|
||||
5. **Archive propre** : Anciens fichiers conservés mais séparés
|
||||
6. **Exemples pratiques** : Exemples d'utilisation organisés
|
||||
|
||||
## 🔄 Commandes de Migration
|
||||
|
||||
### Migration Automatique
|
||||
```bash
|
||||
# Exécuter la migration complète
|
||||
./migrate_documentation.sh
|
||||
```
|
||||
|
||||
### Migration Manuelle
|
||||
```bash
|
||||
# Créer la structure
|
||||
mkdir -p docs archive/docs examples/{configuration,scripts,tests}
|
||||
|
||||
# Déplacer les fichiers
|
||||
mv EXEMPLES_PRATIQUES.md archive/docs/
|
||||
mv CONFIGURATION_DEV3.md archive/docs/
|
||||
mv INTEGRATION_DEV3_FINAL.md archive/docs/
|
||||
mv COMMANDES_REDEMARRAGE.md archive/docs/
|
||||
mv RESUME_AJOUT_DEV3.md archive/docs/
|
||||
mv RESUME_DECOUVERTE_NOEUDS.md archive/docs/
|
||||
mv RESUME_SCRIPT_RESTART.md archive/docs/
|
||||
mv RESUME_TEST_3_RELAIS.md archive/docs/
|
||||
mv README_RESTART_SCRIPT.md archive/docs/
|
||||
mv explain_node_discovery.md archive/docs/
|
||||
|
||||
# Fusionner les spécifications
|
||||
cat specs/spec-technical.md >> specs/spec-technique.md
|
||||
rm specs/spec-technical.md
|
||||
|
||||
# Créer le README de l'archive
|
||||
cat > archive/README.md << 'EOF'
|
||||
# 📦 Archive - Documentation 4NK Node
|
||||
|
||||
Ce dossier contient les anciens fichiers de documentation qui ont été migrés vers la nouvelle structure organisée.
|
||||
|
||||
## 📁 Contenu
|
||||
|
||||
- `docs/` - Anciens fichiers de documentation
|
||||
- `README.md` - Ce fichier
|
||||
|
||||
## 🔗 Liens vers la Nouvelle Documentation
|
||||
|
||||
- **Documentation principale** : [../docs/INDEX.md](../docs/INDEX.md)
|
||||
- **Guide d'installation** : [../docs/INSTALLATION.md](../docs/INSTALLATION.md)
|
||||
- **Guide d'utilisation** : [../docs/USAGE.md](../docs/USAGE.md)
|
||||
- **Guide de configuration** : [../docs/CONFIGURATION.md](../docs/CONFIGURATION.md)
|
||||
- **Référence rapide** : [../docs/QUICK_REFERENCE.md](../docs/QUICK_REFERENCE.md)
|
||||
|
||||
## 📅 Date de Migration
|
||||
|
||||
Migration effectuée le : $(date)
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**🔄 Migration de Documentation 4NK Node - Structure organisée et maintenable !**
|
||||
@ -1,492 +0,0 @@
|
||||
# ⚡ Référence Rapide - 4NK Node
|
||||
|
||||
Référence rapide des commandes essentielles pour l'infrastructure 4NK Node.
|
||||
|
||||
## 🚀 Démarrage
|
||||
|
||||
### Démarrage Complet
|
||||
```bash
|
||||
# Démarrer tous les services
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Vérifier le statut
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Démarrage Séquentiel
|
||||
```bash
|
||||
# Démarrer Tor
|
||||
./restart_4nk_node.sh -t
|
||||
|
||||
# Démarrer Bitcoin Core
|
||||
./restart_4nk_node.sh -b
|
||||
|
||||
# Démarrer Blindbit
|
||||
./restart_4nk_node.sh -l
|
||||
|
||||
# Démarrer les relais
|
||||
./restart_4nk_node.sh -r
|
||||
```
|
||||
|
||||
### Options du Script de Redémarrage
|
||||
```bash
|
||||
./restart_4nk_node.sh -h # Aide
|
||||
./restart_4nk_node.sh -s # Arrêter
|
||||
./restart_4nk_node.sh -c # Nettoyer
|
||||
./restart_4nk_node.sh -n # Créer réseau
|
||||
./restart_4nk_node.sh -t # Démarrer Tor
|
||||
./restart_4nk_node.sh -b # Démarrer Bitcoin
|
||||
./restart_4nk_node.sh -l # Démarrer Blindbit
|
||||
./restart_4nk_node.sh -r # Démarrer relais
|
||||
./restart_4nk_node.sh -v # Vérifier statut
|
||||
```
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### Statut des Services
|
||||
```bash
|
||||
# Statut de tous les services
|
||||
docker ps
|
||||
|
||||
# Statut avec format personnalisé
|
||||
docker ps --format "table {{.Names}}\t{{.Status}}\t{{.Ports}}"
|
||||
|
||||
# Utilisation des ressources
|
||||
docker stats
|
||||
|
||||
# Espace disque
|
||||
docker system df
|
||||
```
|
||||
|
||||
### Logs
|
||||
```bash
|
||||
# Logs de tous les services
|
||||
docker-compose logs -f
|
||||
|
||||
# Logs d'un service spécifique
|
||||
docker logs bitcoin-signet
|
||||
docker logs blindbit-oracle
|
||||
docker logs sdk_relay_1
|
||||
|
||||
# Logs avec timestamps
|
||||
docker-compose logs -t
|
||||
|
||||
# Logs des 100 dernières lignes
|
||||
docker-compose logs --tail=100
|
||||
|
||||
# Logs depuis une date
|
||||
docker-compose logs --since="2024-01-01T00:00:00"
|
||||
```
|
||||
|
||||
### Surveillance de la Synchronisation
|
||||
```bash
|
||||
# Surveillance en temps réel
|
||||
./monitor_sync.sh
|
||||
|
||||
# Test de synchronisation
|
||||
./test_sync_logs.sh
|
||||
|
||||
# Test de synchronisation forcé
|
||||
./test_sync_logs.sh force
|
||||
|
||||
# Test de synchronisation en continu
|
||||
./test_sync_logs.sh continuous
|
||||
```
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
### Tests de Base
|
||||
```bash
|
||||
# Test de connectivité complet
|
||||
./test_final_sync.sh
|
||||
|
||||
# Test de synchronisation
|
||||
./test_sync_logs.sh
|
||||
|
||||
# Test des messages WebSocket
|
||||
python3 test_websocket_messages.py
|
||||
|
||||
# Test des 3 relais
|
||||
./test_3_relays.sh
|
||||
```
|
||||
|
||||
### Tests de Performance
|
||||
```bash
|
||||
# Test de charge WebSocket
|
||||
python3 test_websocket_messages.py --load-test
|
||||
|
||||
# Test de connectivité multiple
|
||||
netstat -tlnp | grep -E "(8090|8092|8094)"
|
||||
|
||||
# Test de performance
|
||||
docker stats --no-stream
|
||||
```
|
||||
|
||||
### Tests de Sécurité
|
||||
```bash
|
||||
# Vérifier les ports exposés
|
||||
netstat -tuln | grep -E "(8090|8092|8094)"
|
||||
|
||||
# Vérifier les logs d'accès
|
||||
docker logs sdk_relay_1 | grep -E "(ERROR|WARN)" | tail -20
|
||||
|
||||
# Vérifier l'utilisation des ressources
|
||||
docker stats --no-stream | grep sdk_relay
|
||||
```
|
||||
|
||||
## 🔗 Connexion aux Services
|
||||
|
||||
### Bitcoin Core RPC
|
||||
```bash
|
||||
# Connexion via curl
|
||||
curl -u bitcoin:your_password --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockchaininfo", "params": []}' -H 'content-type: text/plain;' http://localhost:18443/
|
||||
|
||||
# Connexion via bitcoin-cli
|
||||
docker exec bitcoin-signet bitcoin-cli -signet getblockchaininfo
|
||||
|
||||
# Vérifier la synchronisation
|
||||
docker exec bitcoin-signet bitcoin-cli -signet getblockchaininfo | jq '.verificationprogress'
|
||||
```
|
||||
|
||||
### Blindbit API
|
||||
```bash
|
||||
# Test de connectivité
|
||||
curl -s http://localhost:8000/
|
||||
|
||||
# Vérifier le statut
|
||||
curl -s http://localhost:8000/status
|
||||
|
||||
# Obtenir des filtres
|
||||
curl -s http://localhost:8000/filters
|
||||
```
|
||||
|
||||
### sdk_relay WebSocket
|
||||
```bash
|
||||
# Test de connectivité WebSocket
|
||||
curl -v -H "Connection: Upgrade" -H "Upgrade: websocket" -H "Sec-WebSocket-Key: test" http://localhost:8090/
|
||||
|
||||
# Test avec wscat (si installé)
|
||||
wscat -c ws://localhost:8090
|
||||
|
||||
# Test avec Python
|
||||
python3 test_websocket_messages.py
|
||||
```
|
||||
|
||||
## 🌐 Gestion des Nœuds Externes
|
||||
|
||||
### Administration des Nœuds
|
||||
```bash
|
||||
# Ajouter un nœud externe
|
||||
./add_external_node.sh add external-relay-1 external-relay-1.example.com:8090
|
||||
|
||||
# Lister les nœuds configurés
|
||||
./add_external_node.sh list
|
||||
|
||||
# Tester la connectivité
|
||||
./add_external_node.sh test external-relay-1
|
||||
|
||||
# Supprimer un nœud
|
||||
./add_external_node.sh remove external-relay-1
|
||||
|
||||
# Valider une adresse
|
||||
./add_external_node.sh validate 192.168.1.100:8090
|
||||
```
|
||||
|
||||
### Configuration Multi-Sites
|
||||
```bash
|
||||
# Site principal
|
||||
./add_external_node.sh add site-paris-1 paris-relay-1.4nk.net:8090
|
||||
./add_external_node.sh add site-paris-2 paris-relay-2.4nk.net:8090
|
||||
|
||||
# Site secondaire
|
||||
./add_external_node.sh add site-lyon-1 lyon-relay-1.4nk.net:8090
|
||||
./add_external_node.sh add site-lyon-2 lyon-relay-2.4nk.net:8090
|
||||
|
||||
# Site de backup
|
||||
./add_external_node.sh add backup-1 backup-relay-1.4nk.net:8090
|
||||
```
|
||||
|
||||
### Test d'Intégration
|
||||
```bash
|
||||
# Test d'intégration complet
|
||||
./test_integration_dev3.sh
|
||||
|
||||
# Test de connectivité dev3
|
||||
python3 test_dev3_simple.py
|
||||
|
||||
# Test de connectivité avancé
|
||||
python3 test_dev3_connectivity.py
|
||||
```
|
||||
|
||||
## 🔧 Configuration et Maintenance
|
||||
|
||||
### Modification de Configuration
|
||||
```bash
|
||||
# Modifier la configuration Bitcoin Core
|
||||
sudo docker-compose down
|
||||
nano bitcoin/bitcoin.conf
|
||||
sudo docker-compose up -d bitcoin
|
||||
|
||||
# Modifier la configuration Blindbit
|
||||
nano blindbit/blindbit.toml
|
||||
sudo docker-compose restart blindbit
|
||||
|
||||
# Modifier la configuration des relais
|
||||
nano sdk_relay/.conf.docker.relay1
|
||||
sudo docker-compose restart sdk_relay_1
|
||||
```
|
||||
|
||||
### Redémarrage des Services
|
||||
```bash
|
||||
# Redémarrage complet
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Redémarrage d'un service spécifique
|
||||
docker-compose restart bitcoin
|
||||
docker-compose restart blindbit
|
||||
docker-compose restart sdk_relay_1
|
||||
|
||||
# Redémarrage avec reconstruction
|
||||
docker-compose down
|
||||
docker-compose build --no-cache
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Sauvegarde et Restauration
|
||||
```bash
|
||||
# Sauvegarde des données
|
||||
docker exec bitcoin-signet tar czf /tmp/bitcoin-backup.tar.gz /home/bitcoin/.bitcoin
|
||||
docker cp bitcoin-signet:/tmp/bitcoin-backup.tar.gz ./backup/
|
||||
|
||||
# Sauvegarde des configurations
|
||||
tar czf config-backup.tar.gz sdk_relay/.conf* external_nodes.conf
|
||||
|
||||
# Restauration
|
||||
docker cp ./backup/bitcoin-backup.tar.gz bitcoin-signet:/tmp/
|
||||
docker exec bitcoin-signet tar xzf /tmp/bitcoin-backup.tar.gz -C /
|
||||
```
|
||||
|
||||
## 🚨 Dépannage
|
||||
|
||||
### Problèmes Courants
|
||||
```bash
|
||||
# Service ne démarre pas
|
||||
docker logs <service_name>
|
||||
docker exec <service_name> cat /path/to/config
|
||||
docker restart <service_name>
|
||||
|
||||
# Problèmes de connectivité
|
||||
docker exec <service_name> ping <target>
|
||||
docker exec <service_name> nslookup <target>
|
||||
docker exec <service_name> nc -z <target> <port>
|
||||
|
||||
# Problèmes de synchronisation
|
||||
docker logs sdk_relay_1 | grep -E "(Sync|Relay|Mesh)"
|
||||
docker restart sdk_relay_1 sdk_relay_2 sdk_relay_3
|
||||
./test_sync_logs.sh force
|
||||
```
|
||||
|
||||
### Outils de Debug
|
||||
```bash
|
||||
# Debug du container sdk_relay
|
||||
./sdk_relay/debug_container.sh
|
||||
|
||||
# Test du healthcheck
|
||||
./sdk_relay/test_healthcheck.sh
|
||||
|
||||
# Test de connectivité
|
||||
./sdk_relay/test_connectivity.sh
|
||||
|
||||
# Test simple
|
||||
./sdk_relay/test_simple.sh
|
||||
```
|
||||
|
||||
### Logs de Debug
|
||||
```bash
|
||||
# Logs détaillés
|
||||
docker-compose logs -f --tail=100
|
||||
|
||||
# Logs d'un service spécifique
|
||||
docker logs <service_name> -f
|
||||
|
||||
# Logs avec timestamps
|
||||
docker-compose logs -t
|
||||
|
||||
# Logs depuis une date
|
||||
docker-compose logs --since="2024-01-01T00:00:00"
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
### Vérification de Sécurité
|
||||
```bash
|
||||
# Vérifier les ports exposés
|
||||
netstat -tuln | grep -E "(8090|8092|8094)"
|
||||
|
||||
# Vérifier les permissions
|
||||
ls -la sdk_relay/.conf*
|
||||
ls -la bitcoin/bitcoin.conf
|
||||
ls -la blindbit/blindbit.toml
|
||||
|
||||
# Vérifier les logs de sécurité
|
||||
docker logs sdk_relay_1 | grep -E "(ERROR|WARN|SECURITY)" | tail -20
|
||||
```
|
||||
|
||||
### Configuration de Pare-feu
|
||||
```bash
|
||||
# Autoriser les ports nécessaires
|
||||
sudo ufw allow 18443/tcp # Bitcoin Core RPC
|
||||
sudo ufw allow 8090/tcp # sdk_relay WebSocket
|
||||
sudo ufw allow 8000/tcp # Blindbit API
|
||||
sudo ufw enable
|
||||
|
||||
# Vérifier les règles
|
||||
sudo ufw status numbered
|
||||
```
|
||||
|
||||
## 📈 Performance
|
||||
|
||||
### Optimisation
|
||||
```bash
|
||||
# Limiter l'utilisation CPU
|
||||
docker-compose up -d --scale bitcoin=1
|
||||
|
||||
# Optimiser la mémoire
|
||||
docker stats --no-stream | grep sdk_relay
|
||||
|
||||
# Nettoyer l'espace disque
|
||||
docker system prune -f
|
||||
```
|
||||
|
||||
### Monitoring de Performance
|
||||
```bash
|
||||
# Surveillance des ressources
|
||||
docker stats
|
||||
|
||||
# Surveillance des connexions
|
||||
netstat -an | grep :8090 | wc -l
|
||||
|
||||
# Surveillance de l'espace disque
|
||||
df -h
|
||||
```
|
||||
|
||||
### Tests de Charge
|
||||
```bash
|
||||
# Test de charge simple
|
||||
for i in {1..50}; do
|
||||
python3 test_websocket_messages.py &
|
||||
sleep 0.1
|
||||
done
|
||||
wait
|
||||
|
||||
# Test de charge avancé
|
||||
python3 test_websocket_messages.py --load-test --duration=300
|
||||
```
|
||||
|
||||
## 🔄 Maintenance
|
||||
|
||||
### Nettoyage
|
||||
```bash
|
||||
# Nettoyer les conteneurs arrêtés
|
||||
docker container prune -f
|
||||
|
||||
# Nettoyer les images non utilisées
|
||||
docker image prune -f
|
||||
|
||||
# Nettoyer les volumes non utilisés
|
||||
docker volume prune -f
|
||||
|
||||
# Nettoyer tout
|
||||
docker system prune -a -f
|
||||
```
|
||||
|
||||
### Mise à Jour
|
||||
```bash
|
||||
# Mise à jour de l'infrastructure
|
||||
git pull origin main
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Mise à jour des images
|
||||
docker-compose build --no-cache
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Sauvegarde Automatique
|
||||
```bash
|
||||
# Script de sauvegarde
|
||||
cat > backup_4nk.sh << 'EOF'
|
||||
#!/bin/bash
|
||||
DATE=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/backup/4nk_node_$DATE"
|
||||
mkdir -p $BACKUP_DIR
|
||||
cp -r sdk_relay/.conf* $BACKUP_DIR/
|
||||
cp external_nodes.conf $BACKUP_DIR/
|
||||
docker exec bitcoin-signet tar czf /tmp/bitcoin-backup.tar.gz /home/bitcoin/.bitcoin
|
||||
docker cp bitcoin-signet:/tmp/bitcoin-backup.tar.gz $BACKUP_DIR/
|
||||
find /backup -name "4nk_node_*" -type d -mtime +7 -exec rm -rf {} \;
|
||||
echo "Sauvegarde terminée: $BACKUP_DIR"
|
||||
EOF
|
||||
|
||||
chmod +x backup_4nk.sh
|
||||
|
||||
# Ajouter au cron
|
||||
echo "0 2 * * * /path/to/backup_4nk.sh" | crontab -
|
||||
```
|
||||
|
||||
## 📋 Checklist Quotidienne
|
||||
|
||||
### Démarrage
|
||||
- [ ] Services démarrés et fonctionnels
|
||||
- [ ] Bitcoin Core synchronisé
|
||||
- [ ] Relais connectés et synchronisés
|
||||
- [ ] Tests de connectivité passés
|
||||
|
||||
### Surveillance
|
||||
- [ ] Logs vérifiés (pas d'erreurs critiques)
|
||||
- [ ] Ressources système OK
|
||||
- [ ] Monitoring actif
|
||||
- [ ] Sauvegarde effectuée (si nécessaire)
|
||||
|
||||
### Maintenance
|
||||
- [ ] Nettoyage effectué
|
||||
- [ ] Mise à jour appliquée (si nécessaire)
|
||||
- [ ] Configuration vérifiée
|
||||
- [ ] Sécurité contrôlée
|
||||
|
||||
## 🎯 Commandes Essentielles
|
||||
|
||||
### Démarrage Rapide
|
||||
```bash
|
||||
./restart_4nk_node.sh
|
||||
docker ps
|
||||
./test_final_sync.sh
|
||||
```
|
||||
|
||||
### Monitoring Rapide
|
||||
```bash
|
||||
docker ps
|
||||
docker-compose logs -f
|
||||
./monitor_sync.sh
|
||||
```
|
||||
|
||||
### Test Rapide
|
||||
```bash
|
||||
./test_final_sync.sh
|
||||
./test_sync_logs.sh
|
||||
python3 test_websocket_messages.py
|
||||
```
|
||||
|
||||
### Dépannage Rapide
|
||||
```bash
|
||||
docker logs <service_name>
|
||||
docker restart <service_name>
|
||||
./test_sync_logs.sh force
|
||||
```
|
||||
|
||||
### Arrêt Propre
|
||||
```bash
|
||||
docker-compose down
|
||||
docker system prune -f
|
||||
```
|
||||
|
||||
---
|
||||
@ -1,322 +0,0 @@
|
||||
# Documentation SSH complète - ihm_client
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Ce document consolide toute la documentation SSH pour le projet `ihm_client`, couvrant l'automatisation des push, la configuration CI/CD, et les bonnes pratiques de sécurité.
|
||||
|
||||
## Table des matières
|
||||
|
||||
- [Configuration automatique](#configuration-automatique)
|
||||
- [Scripts d'automatisation](#scripts-dautomatisation)
|
||||
- [Workflow CI/CD](#workflow-cicd)
|
||||
- [Alias Git](#alias-git)
|
||||
- [Bonnes pratiques](#bonnes-pratiques)
|
||||
- [Dépannage](#dépannage)
|
||||
|
||||
---
|
||||
|
||||
## Configuration automatique
|
||||
|
||||
### Configuration Git globale
|
||||
|
||||
La configuration SSH est automatiquement appliquée pour tous les push :
|
||||
|
||||
```bash
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### Vérification SSH
|
||||
|
||||
Test automatique de la connexion SSH :
|
||||
|
||||
```bash
|
||||
ssh -T git@git.4nkweb.com
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scripts d'automatisation
|
||||
|
||||
### 1. Script principal : `auto-ssh-push.sh`
|
||||
|
||||
Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique :
|
||||
|
||||
#### Options disponibles
|
||||
|
||||
```bash
|
||||
# Push rapide (message automatique)
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Push avec message personnalisé
|
||||
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"
|
||||
|
||||
# Push sur une branche spécifique
|
||||
./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite
|
||||
|
||||
# Push et merge (avec confirmation)
|
||||
./scripts/auto-ssh-push.sh merge
|
||||
|
||||
# Vérification du statut
|
||||
./scripts/auto-ssh-push.sh status
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- **Configuration SSH automatique** - Plus besoin de configurer SSH manuellement
|
||||
- **Push automatique** - Ajout, commit et push en une commande
|
||||
- **Gestion des branches** - Support des branches personnalisées
|
||||
- **Vérification SSH** - Test automatique de la connexion SSH
|
||||
- **Messages de commit** - Messages automatiques ou personnalisés
|
||||
|
||||
### 2. Script d'initialisation : `init-ssh-env.sh`
|
||||
|
||||
Le script `scripts/init-ssh-env.sh` configure automatiquement l'environnement SSH :
|
||||
|
||||
```bash
|
||||
./scripts/init-ssh-env.sh
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- Vérification de l'environnement de développement
|
||||
- Configuration SSH automatique
|
||||
- Test de connectivité SSH
|
||||
- Configuration des alias Git
|
||||
- Validation de la configuration
|
||||
|
||||
### 3. Script CI/CD : `setup-ssh-ci.sh`
|
||||
|
||||
Le script `scripts/setup-ssh-ci.sh` configure SSH pour les environnements CI/CD :
|
||||
|
||||
```bash
|
||||
./scripts/setup-ssh-ci.sh
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- Détection automatique de l'environnement CI
|
||||
- Configuration SSH pour Gitea Actions
|
||||
- Gestion des clés SSH privées
|
||||
- Test de connexion SSH
|
||||
- Configuration Git pour SSH
|
||||
|
||||
---
|
||||
|
||||
## Workflow CI/CD
|
||||
|
||||
### Configuration Gitea Actions
|
||||
|
||||
Le workflow CI/CD dans `.gitea/workflows/ci.yml` inclut une étape de configuration SSH :
|
||||
|
||||
```yaml
|
||||
- name: Setup SSH for Gitea
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H git.4nkweb.com >> ~/.ssh/known_hosts
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### Variables d'environnement requises
|
||||
|
||||
- `SSH_PRIVATE_KEY` : Clé SSH privée pour l'authentification
|
||||
- `SSH_PUBLIC_KEY` : Clé SSH publique (optionnelle)
|
||||
|
||||
### Jobs configurés
|
||||
|
||||
- **test** : Tests unitaires et d'intégration
|
||||
- **security** : Tests de sécurité et audit
|
||||
- **integration-test** : Tests d'intégration complets
|
||||
|
||||
---
|
||||
|
||||
## Alias Git
|
||||
|
||||
### Alias configurés
|
||||
|
||||
```bash
|
||||
# Push rapide avec message automatique
|
||||
git quick-push
|
||||
|
||||
# Push avec message personnalisé
|
||||
git ssh-push "Mon message de commit"
|
||||
```
|
||||
|
||||
### Configuration des alias
|
||||
|
||||
```bash
|
||||
# Alias pour push rapide
|
||||
git config --global alias.quick-push '!f() { git add . && git commit -m "Update $(date)" && git push origin $(git branch --show-current); }; f'
|
||||
|
||||
# Alias pour push avec message
|
||||
git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto-commit $(date)}" && git push origin $(git branch --show-current); }; f'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Bonnes pratiques
|
||||
|
||||
### Sécurité
|
||||
|
||||
1. **Permissions des clés SSH**
|
||||
```bash
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
chmod 600 ~/.ssh/config
|
||||
```
|
||||
|
||||
2. **Configuration SSH sécurisée**
|
||||
```bash
|
||||
Host git.4nkweb.com
|
||||
HostName git.4nkweb.com
|
||||
User git
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
StrictHostKeyChecking no
|
||||
UserKnownHostsFile=/dev/null
|
||||
```
|
||||
|
||||
3. **Gestion des secrets**
|
||||
- Ne jamais commiter de clés SSH dans le code
|
||||
- Utiliser les secrets Gitea pour les clés privées
|
||||
- Rotation régulière des clés SSH
|
||||
|
||||
### Workflow recommandé
|
||||
|
||||
1. **Initialisation**
|
||||
```bash
|
||||
./scripts/init-ssh-env.sh
|
||||
```
|
||||
|
||||
2. **Développement quotidien**
|
||||
```bash
|
||||
# Push rapide
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Ou avec alias Git
|
||||
git quick-push
|
||||
```
|
||||
|
||||
3. **Push avec message**
|
||||
```bash
|
||||
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dépannage
|
||||
|
||||
### Problèmes courants
|
||||
|
||||
#### 1. Échec d'authentification SSH
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration SSH
|
||||
ssh -T git@git.4nkweb.com
|
||||
|
||||
# Vérifier les permissions
|
||||
ls -la ~/.ssh/
|
||||
|
||||
# Régénérer la clé SSH si nécessaire
|
||||
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk
|
||||
```
|
||||
|
||||
#### 2. Configuration Git incorrecte
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration Git
|
||||
git config --global --list | grep url
|
||||
|
||||
# Reconfigurer SSH
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
#### 3. Problèmes CI/CD
|
||||
|
||||
```bash
|
||||
# Vérifier les variables d'environnement
|
||||
echo $SSH_PRIVATE_KEY
|
||||
|
||||
# Tester la configuration SSH
|
||||
./scripts/setup-ssh-ci.sh
|
||||
```
|
||||
|
||||
### Messages d'erreur courants
|
||||
|
||||
- **"Permission denied"** : Vérifier les permissions des clés SSH
|
||||
- **"Host key verification failed"** : Ajouter l'hôte aux known_hosts
|
||||
- **"Could not resolve hostname"** : Vérifier la connectivité réseau
|
||||
|
||||
### Logs et debugging
|
||||
|
||||
```bash
|
||||
# Activer le debug SSH
|
||||
ssh -vT git@git.4nkweb.com
|
||||
|
||||
# Vérifier les logs Git
|
||||
GIT_SSH_COMMAND="ssh -v" git push origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Intégration avec 4NK_node
|
||||
|
||||
### Configuration pour l'intégration
|
||||
|
||||
Le projet `ihm_client` est configuré pour s'intégrer dans l'infrastructure `4NK_node` :
|
||||
|
||||
1. **Script d'intégration** : `scripts/integrate-4nk-node.sh`
|
||||
2. **Configuration Docker** : `Dockerfile.4nk-node`
|
||||
3. **Configuration Nginx** : `nginx.4nk-node.conf`
|
||||
4. **Script de démarrage** : `start-4nk-node.sh`
|
||||
|
||||
### Workflow d'intégration
|
||||
|
||||
```bash
|
||||
# Intégrer ihm_client dans 4NK_node
|
||||
./scripts/integrate-4nk-node.sh
|
||||
|
||||
# Vérifier l'intégration
|
||||
docker-compose -f docker-compose.4nk-node.yml up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Évolution future
|
||||
|
||||
### Améliorations prévues
|
||||
|
||||
1. **Support multi-environnements**
|
||||
- Configuration automatique pour différents environnements
|
||||
- Gestion des clés SSH multiples
|
||||
|
||||
2. **Intégration avancée**
|
||||
- Support des hooks Git
|
||||
- Intégration avec d'autres outils CI/CD
|
||||
|
||||
3. **Sécurité renforcée**
|
||||
- Support des clés SSH temporaires
|
||||
- Audit automatique des permissions
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Vérification régulière de la configuration SSH
|
||||
- Mise à jour des scripts d'automatisation
|
||||
- Documentation des nouvelles fonctionnalités
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
L'automatisation SSH pour `ihm_client` simplifie considérablement le workflow de développement en éliminant la nécessité de configurer manuellement SSH pour chaque opération Git. Les scripts et alias fournis offrent une interface simple et sécurisée pour tous les push vers le repository.
|
||||
|
||||
### Ressources
|
||||
|
||||
- [Documentation SSH officielle](https://git-scm.com/book/fr/v2/Git-sur-le-serveur-Génération-d-une-clé-SSH)
|
||||
- [Guide Gitea SSH](https://docs.gitea.com/usage/ssh-setup)
|
||||
- [Bonnes pratiques SSH](https://www.ssh.com/academy/ssh/key)
|
||||
|
||||
---
|
||||
|
||||
**Dernière mise à jour** : $(date '+%Y-%m-%d')
|
||||
**Version** : 1.0.0
|
||||
763
docs/API.md
763
docs/API.md
@ -1,763 +0,0 @@
|
||||
# Référence API - 4NK Node
|
||||
|
||||
Ce guide documente toutes les APIs disponibles dans l'infrastructure 4NK Node, incluant les interfaces RPC, HTTP et WebSocket.
|
||||
|
||||
## Vue d'Ensemble des APIs
|
||||
|
||||
L'infrastructure 4NK Node expose plusieurs interfaces pour différents types d'interactions :
|
||||
|
||||
- **Bitcoin Core RPC** : Interface JSON-RPC pour Bitcoin
|
||||
- **Blindbit HTTP** : API REST pour les paiements silencieux
|
||||
- **SDK Relay WebSocket** : Interface temps réel pour les clients
|
||||
- **SDK Relay HTTP** : API REST pour les opérations de gestion
|
||||
|
||||
## 1. API Bitcoin Core RPC
|
||||
|
||||
### Informations Générales
|
||||
|
||||
- **Protocole :** JSON-RPC
|
||||
- **Port :** 18443
|
||||
- **Authentification :** Cookie ou credentials
|
||||
- **Réseau :** Signet
|
||||
- **Base URL :** `http://localhost:18443`
|
||||
|
||||
### Authentification
|
||||
|
||||
#### Méthode Cookie (Recommandée)
|
||||
```bash
|
||||
# Le cookie est automatiquement utilisé par Bitcoin Core
|
||||
curl -X POST http://localhost:18443 \
|
||||
-H "Content-Type: application/json" \
|
||||
--data '{"jsonrpc": "1.0", "id": "test", "method": "getblockchaininfo", "params": []}'
|
||||
```
|
||||
|
||||
#### Méthode Credentials
|
||||
```bash
|
||||
curl -X POST http://localhost:18443 \
|
||||
-H "Content-Type: application/json" \
|
||||
-u "username:password" \
|
||||
--data '{"jsonrpc": "1.0", "id": "test", "method": "getblockchaininfo", "params": []}'
|
||||
```
|
||||
|
||||
### Endpoints Principaux
|
||||
|
||||
#### getblockchaininfo
|
||||
Récupère les informations sur la blockchain.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getblockchaininfo",
|
||||
"params": []
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"chain": "signet",
|
||||
"blocks": 12345,
|
||||
"headers": 12345,
|
||||
"bestblockhash": "0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"difficulty": 1.0,
|
||||
"mediantime": 1234567890,
|
||||
"verificationprogress": 1.0,
|
||||
"initialblockdownload": false,
|
||||
"chainwork": "0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"size_on_disk": 123456789,
|
||||
"pruned": false,
|
||||
"pruneheight": null,
|
||||
"automatic_pruning": false,
|
||||
"prune_target_size": null,
|
||||
"warnings": ""
|
||||
},
|
||||
"error": null,
|
||||
"id": "test"
|
||||
}
|
||||
```
|
||||
|
||||
#### getblock
|
||||
Récupère les informations d'un bloc spécifique.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getblock",
|
||||
"params": ["blockhash", 2]
|
||||
}
|
||||
```
|
||||
|
||||
**Paramètres :**
|
||||
- `blockhash` : Hash du bloc
|
||||
- `verbosity` : Niveau de détail (0, 1, 2)
|
||||
|
||||
#### getrawtransaction
|
||||
Récupère une transaction brute.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getrawtransaction",
|
||||
"params": ["txid", true]
|
||||
}
|
||||
```
|
||||
|
||||
#### sendrawtransaction
|
||||
Envoie une transaction brute au réseau.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "sendrawtransaction",
|
||||
"params": ["hexstring"]
|
||||
}
|
||||
```
|
||||
|
||||
#### getwalletinfo
|
||||
Récupère les informations du wallet.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getwalletinfo",
|
||||
"params": []
|
||||
}
|
||||
```
|
||||
|
||||
### Gestion des Erreurs
|
||||
|
||||
**Erreur typique :**
|
||||
```json
|
||||
{
|
||||
"result": null,
|
||||
"error": {
|
||||
"code": -32601,
|
||||
"message": "Method not found"
|
||||
},
|
||||
"id": "test"
|
||||
}
|
||||
```
|
||||
|
||||
**Codes d'erreur courants :**
|
||||
- `-32601` : Méthode non trouvée
|
||||
- `-32602` : Paramètres invalides
|
||||
- `-32603` : Erreur interne
|
||||
- `-1` : Erreur d'authentification
|
||||
|
||||
## 2. API Blindbit HTTP
|
||||
|
||||
### Informations Générales
|
||||
|
||||
- **Protocole :** HTTP REST
|
||||
- **Port :** 8000
|
||||
- **Base URL :** `http://localhost:8000`
|
||||
- **Content-Type :** `application/json`
|
||||
|
||||
### Endpoints
|
||||
|
||||
#### GET /health
|
||||
Vérifie la santé du service.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8000/health
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"status": "healthy",
|
||||
"timestamp": "2024-12-19T14:30:00Z",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /generate-address
|
||||
Génère une adresse de paiement silencieux.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"label": "payment_001",
|
||||
"amount": 0.001
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"address": "bc1p...",
|
||||
"label": "payment_001",
|
||||
"amount": 0.001,
|
||||
"created_at": "2024-12-19T14:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /payments
|
||||
Liste les paiements reçus.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET "http://localhost:8000/payments?limit=10&offset=0"
|
||||
```
|
||||
|
||||
**Paramètres de requête :**
|
||||
- `limit` : Nombre maximum de résultats (défaut: 10)
|
||||
- `offset` : Décalage pour la pagination (défaut: 0)
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"payments": [
|
||||
{
|
||||
"id": "payment_001",
|
||||
"address": "bc1p...",
|
||||
"amount": 0.001,
|
||||
"txid": "txid...",
|
||||
"block_height": 12345,
|
||||
"created_at": "2024-12-19T14:30:00Z"
|
||||
}
|
||||
],
|
||||
"total": 1,
|
||||
"limit": 10,
|
||||
"offset": 0
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /payments/{id}
|
||||
Récupère les détails d'un paiement spécifique.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8000/payments/payment_001
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"id": "payment_001",
|
||||
"address": "bc1p...",
|
||||
"amount": 0.001,
|
||||
"txid": "txid...",
|
||||
"block_height": 12345,
|
||||
"confirmations": 6,
|
||||
"created_at": "2024-12-19T14:30:00Z",
|
||||
"status": "confirmed"
|
||||
}
|
||||
```
|
||||
|
||||
### Codes de Statut HTTP
|
||||
|
||||
- `200` : Succès
|
||||
- `201` : Créé
|
||||
- `400` : Requête invalide
|
||||
- `404` : Ressource non trouvée
|
||||
- `500` : Erreur serveur
|
||||
|
||||
## 3. API SDK Relay WebSocket
|
||||
|
||||
### Informations Générales
|
||||
|
||||
- **Protocole :** WebSocket/WSS
|
||||
- **Port :** 8090
|
||||
- **URL :** `ws://localhost:8090` ou `wss://localhost:8090`
|
||||
- **Format :** JSON
|
||||
|
||||
### Connexion
|
||||
|
||||
```javascript
|
||||
const ws = new WebSocket('ws://localhost:8090');
|
||||
|
||||
ws.onopen = function() {
|
||||
console.log('Connexion WebSocket établie');
|
||||
};
|
||||
|
||||
ws.onmessage = function(event) {
|
||||
const message = JSON.parse(event.data);
|
||||
console.log('Message reçu:', message);
|
||||
};
|
||||
|
||||
ws.onerror = function(error) {
|
||||
console.error('Erreur WebSocket:', error);
|
||||
};
|
||||
|
||||
ws.onclose = function() {
|
||||
console.log('Connexion WebSocket fermée');
|
||||
};
|
||||
```
|
||||
|
||||
### Format des Messages
|
||||
|
||||
Tous les messages suivent le format JSON suivant :
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "message_type",
|
||||
"id": "unique_message_id",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
// Données spécifiques au type de message
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Types de Messages
|
||||
|
||||
#### Messages de Synchronisation
|
||||
|
||||
**StateSync :**
|
||||
```json
|
||||
{
|
||||
"type": "StateSync",
|
||||
"id": "state_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"relay_id": "relay-1",
|
||||
"state": "running",
|
||||
"version": "1.0.0",
|
||||
"uptime": 3600
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**HealthSync :**
|
||||
```json
|
||||
{
|
||||
"type": "HealthSync",
|
||||
"id": "health_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"relay_id": "relay-1",
|
||||
"status": "healthy",
|
||||
"uptime": 3600,
|
||||
"cpu_usage": 15.5,
|
||||
"memory_usage": 45.2
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**MetricsSync :**
|
||||
```json
|
||||
{
|
||||
"type": "MetricsSync",
|
||||
"id": "metrics_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"relay_id": "relay-1",
|
||||
"messages_sent": 1000,
|
||||
"messages_received": 950,
|
||||
"sync_errors": 5,
|
||||
"connected_relays": 3
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Messages de Transaction
|
||||
|
||||
**TransactionReceived :**
|
||||
```json
|
||||
{
|
||||
"type": "TransactionReceived",
|
||||
"id": "tx_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"txid": "txid...",
|
||||
"amount": 0.001,
|
||||
"address": "bc1p...",
|
||||
"block_height": 12345,
|
||||
"confirmations": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**BlockScanned :**
|
||||
```json
|
||||
{
|
||||
"type": "BlockScanned",
|
||||
"id": "block_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"block_height": 12345,
|
||||
"block_hash": "hash...",
|
||||
"transactions_count": 150,
|
||||
"silent_payments_found": 2
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Commandes Client
|
||||
|
||||
#### Ping
|
||||
```json
|
||||
{
|
||||
"type": "ping",
|
||||
"id": "ping_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"type": "pong",
|
||||
"id": "ping_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"relay_id": "relay-1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### GetStatus
|
||||
```json
|
||||
{
|
||||
"type": "get_status",
|
||||
"id": "status_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"type": "status",
|
||||
"id": "status_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"relay_id": "relay-1",
|
||||
"status": "running",
|
||||
"uptime": 3600,
|
||||
"connected_relays": 3,
|
||||
"last_block_height": 12345
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 4. API SDK Relay HTTP
|
||||
|
||||
### Informations Générales
|
||||
|
||||
- **Protocole :** HTTP REST
|
||||
- **Port :** 8091
|
||||
- **Base URL :** `http://localhost:8091`
|
||||
- **Content-Type :** `application/json`
|
||||
|
||||
### Endpoints
|
||||
|
||||
#### GET /health
|
||||
Vérifie la santé du relais.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8091/health
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"status": "healthy",
|
||||
"relay_id": "relay-1",
|
||||
"uptime": 3600,
|
||||
"version": "1.0.0",
|
||||
"connected_relays": 3
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /status
|
||||
Récupère le statut détaillé du relais.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8091/status
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"relay_id": "relay-1",
|
||||
"status": "running",
|
||||
"uptime": 3600,
|
||||
"version": "1.0.0",
|
||||
"connected_relays": 3,
|
||||
"last_block_height": 12345,
|
||||
"sync_metrics": {
|
||||
"messages_sent": 1000,
|
||||
"messages_received": 950,
|
||||
"sync_errors": 5
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /relays
|
||||
Liste les relais connectés.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8091/relays
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"relays": [
|
||||
{
|
||||
"relay_id": "relay-2",
|
||||
"address": "sdk_relay_2:8090",
|
||||
"status": "connected",
|
||||
"connected_since": 1234567890,
|
||||
"last_heartbeat": 1234567890
|
||||
},
|
||||
{
|
||||
"relay_id": "relay-3",
|
||||
"address": "sdk_relay_3:8090",
|
||||
"status": "connected",
|
||||
"connected_since": 1234567890,
|
||||
"last_heartbeat": 1234567890
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /metrics
|
||||
Récupère les métriques de synchronisation.
|
||||
|
||||
**Requête :**
|
||||
```bash
|
||||
curl -X GET http://localhost:8091/metrics
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"messages_sent": 1000,
|
||||
"messages_received": 950,
|
||||
"sync_errors": 5,
|
||||
"last_sync_timestamp": 1234567890,
|
||||
"connected_relays": 3,
|
||||
"mesh_health": 0.95
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /sync
|
||||
Force une synchronisation manuelle.
|
||||
|
||||
**Requête :**
|
||||
```json
|
||||
{
|
||||
"sync_type": "StateSync",
|
||||
"target_relay": "relay-2"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse :**
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Synchronisation initiée",
|
||||
"sync_id": "sync_001"
|
||||
}
|
||||
```
|
||||
|
||||
## 5. Gestion des Erreurs
|
||||
|
||||
### Erreurs WebSocket
|
||||
|
||||
**Erreur de connexion :**
|
||||
```json
|
||||
{
|
||||
"type": "error",
|
||||
"id": "error_001",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"code": "CONNECTION_ERROR",
|
||||
"message": "Impossible de se connecter au relais",
|
||||
"details": "Connection refused"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Erreur de message :**
|
||||
```json
|
||||
{
|
||||
"type": "error",
|
||||
"id": "error_002",
|
||||
"timestamp": 1234567890,
|
||||
"data": {
|
||||
"code": "INVALID_MESSAGE",
|
||||
"message": "Format de message invalide",
|
||||
"details": "Missing required field 'type'"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Erreurs HTTP
|
||||
|
||||
**Erreur 400 :**
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": "INVALID_REQUEST",
|
||||
"message": "Requête invalide",
|
||||
"details": "Missing required parameter 'relay_id'"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Erreur 500 :**
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": "INTERNAL_ERROR",
|
||||
"message": "Erreur interne du serveur",
|
||||
"details": "Database connection failed"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 6. Exemples d'Utilisation
|
||||
|
||||
### Exemple Python - WebSocket
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
import websockets
|
||||
import json
|
||||
|
||||
async def connect_to_relay():
|
||||
uri = "ws://localhost:8090"
|
||||
async with websockets.connect(uri) as websocket:
|
||||
# Envoyer un ping
|
||||
ping_message = {
|
||||
"type": "ping",
|
||||
"id": "ping_001",
|
||||
"timestamp": int(time.time()),
|
||||
"data": {}
|
||||
}
|
||||
await websocket.send(json.dumps(ping_message))
|
||||
|
||||
# Écouter les messages
|
||||
async for message in websocket:
|
||||
data = json.loads(message)
|
||||
print(f"Message reçu: {data}")
|
||||
|
||||
asyncio.run(connect_to_relay())
|
||||
```
|
||||
|
||||
### Exemple JavaScript - WebSocket
|
||||
|
||||
```javascript
|
||||
const ws = new WebSocket('ws://localhost:8090');
|
||||
|
||||
ws.onopen = function() {
|
||||
// Envoyer un ping
|
||||
const pingMessage = {
|
||||
type: 'ping',
|
||||
id: 'ping_001',
|
||||
timestamp: Date.now(),
|
||||
data: {}
|
||||
};
|
||||
ws.send(JSON.stringify(pingMessage));
|
||||
};
|
||||
|
||||
ws.onmessage = function(event) {
|
||||
const message = JSON.parse(event.data);
|
||||
console.log('Message reçu:', message);
|
||||
};
|
||||
```
|
||||
|
||||
### Exemple cURL - Bitcoin Core RPC
|
||||
|
||||
```bash
|
||||
# Récupérer les informations de la blockchain
|
||||
curl -X POST http://localhost:18443 \
|
||||
-H "Content-Type: application/json" \
|
||||
--data '{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getblockchaininfo",
|
||||
"params": []
|
||||
}'
|
||||
|
||||
# Récupérer un bloc spécifique
|
||||
curl -X POST http://localhost:18443 \
|
||||
-H "Content-Type: application/json" \
|
||||
--data '{
|
||||
"jsonrpc": "1.0",
|
||||
"id": "test",
|
||||
"method": "getblock",
|
||||
"params": ["blockhash", 2]
|
||||
}'
|
||||
```
|
||||
|
||||
## 7. Limites et Quotas
|
||||
|
||||
### Bitcoin Core RPC
|
||||
- **Taux limite :** 1000 requêtes/minute par défaut
|
||||
- **Taille des requêtes :** 32MB maximum
|
||||
- **Connexions simultanées :** 125 par défaut
|
||||
|
||||
### Blindbit HTTP
|
||||
- **Taux limite :** 100 requêtes/minute
|
||||
- **Taille des requêtes :** 10MB maximum
|
||||
- **Connexions simultanées :** 50
|
||||
|
||||
### SDK Relay WebSocket
|
||||
- **Connexions simultanées :** 1000 par relais
|
||||
- **Taille des messages :** 1MB maximum
|
||||
- **Heartbeat :** 30 secondes
|
||||
|
||||
### SDK Relay HTTP
|
||||
- **Taux limite :** 200 requêtes/minute
|
||||
- **Taille des requêtes :** 5MB maximum
|
||||
- **Connexions simultanées :** 100
|
||||
|
||||
## 8. Sécurité
|
||||
|
||||
### Authentification
|
||||
- **Bitcoin Core :** Cookie d'authentification
|
||||
- **Blindbit :** À définir selon les besoins
|
||||
- **SDK Relay :** Authentification WebSocket (optionnelle)
|
||||
|
||||
### Chiffrement
|
||||
- **RPC Bitcoin :** HTTP (non chiffré en local)
|
||||
- **HTTP Blindbit :** HTTP (non chiffré en local)
|
||||
- **WebSocket SDK Relay :** WSS (chiffré)
|
||||
|
||||
### Bonnes Pratiques
|
||||
- Utiliser HTTPS/WSS en production
|
||||
- Implémenter l'authentification appropriée
|
||||
- Valider toutes les entrées
|
||||
- Limiter les taux de requêtes
|
||||
- Monitorer les accès
|
||||
|
||||
## 9. Monitoring et Observabilité
|
||||
|
||||
### Métriques à Surveiller
|
||||
- **Latence des APIs :** Temps de réponse
|
||||
- **Taux d'erreur :** Pourcentage d'erreurs
|
||||
- **Débit :** Requêtes par seconde
|
||||
- **Utilisation des ressources :** CPU, mémoire, réseau
|
||||
|
||||
### Logs
|
||||
- **Logs d'accès :** Requêtes et réponses
|
||||
- **Logs d'erreur :** Erreurs et exceptions
|
||||
- **Logs de performance :** Métriques de performance
|
||||
|
||||
### Alertes
|
||||
- **Erreurs 5xx :** Erreurs serveur
|
||||
- **Latence élevée :** Temps de réponse > 1s
|
||||
- **Taux d'erreur élevé :** > 5%
|
||||
- **Services indisponibles :** Health checks en échec
|
||||
@ -1,572 +0,0 @@
|
||||
# Architecture Technique - sdk_common
|
||||
|
||||
Ce guide décrit l'architecture technique détaillée de la bibliothèque commune sdk_common pour les Silent Payments Bitcoin.
|
||||
|
||||
## Vue d'Ensemble de l'Architecture
|
||||
|
||||
La bibliothèque sdk_common est conçue comme une couche d'abstraction commune pour les Silent Payments, fournissant des types, traits et utilitaires partagés entre sdk_client et sdk_relay.
|
||||
|
||||
### Architecture Générale
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ sdk_common │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ ┌──────────────┐ │
|
||||
│ │ Types │ │ Traits │ │ Utils │ │
|
||||
│ │ │ │ │ │ │ │
|
||||
│ │ • Wallet │ │ • WalletOps │ │ • Validation │ │
|
||||
│ │ • Transaction │ │ • PaymentOps │ │ • Serialize │ │
|
||||
│ │ • SilentPayment │ │ • NetworkOps │ │ • Crypto │ │
|
||||
│ │ • Address │ │ • ErrorOps │ │ • Encoding │ │
|
||||
│ └─────────────────┘ └─────────────────┘ └──────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
||||
│ sdk_client │ │ sdk_relay │ │ Applications │
|
||||
│ (WASM/JS) │ │ (Rust) │ │ (Rust/JS) │
|
||||
│ │ │ │ │ │
|
||||
│ • Frontend │ │ • Backend │ │ • Intégration │
|
||||
│ • WebAssembly │ │ • WebSocket │ │ • API │
|
||||
│ • TypeScript │ │ • HTTP API │ │ • CLI │
|
||||
└─────────────────┘ └─────────────────┘ └─────────────────┘
|
||||
```
|
||||
|
||||
## Composants Principaux
|
||||
|
||||
### 1. Module Types
|
||||
|
||||
**Rôle :** Définition des structures de données fondamentales pour les Silent Payments.
|
||||
|
||||
**Structures principales :**
|
||||
|
||||
```rust
|
||||
// Wallet - Gestion des clés et identités
|
||||
pub struct Wallet {
|
||||
pub private_key: PrivateKey,
|
||||
pub public_key: PublicKey,
|
||||
pub address: Address,
|
||||
}
|
||||
|
||||
// SilentPayment - Paiement silencieux
|
||||
pub struct SilentPayment {
|
||||
pub scan_key: ScanKey,
|
||||
pub spend_key: SpendKey,
|
||||
pub address: SilentAddress,
|
||||
}
|
||||
|
||||
// Transaction - Transaction Bitcoin
|
||||
pub struct Transaction {
|
||||
pub txid: Txid,
|
||||
pub version: u32,
|
||||
pub inputs: Vec<TxIn>,
|
||||
pub outputs: Vec<TxOut>,
|
||||
pub locktime: u32,
|
||||
}
|
||||
|
||||
// Address - Adresses Bitcoin
|
||||
pub struct Address {
|
||||
pub network: Network,
|
||||
pub address_type: AddressType,
|
||||
pub bytes: Vec<u8>,
|
||||
}
|
||||
```
|
||||
|
||||
**Caractéristiques :**
|
||||
- **Sérialisation :** Support Serde pour JSON/MessagePack
|
||||
- **Validation :** Validation intégrée des données
|
||||
- **Sécurité :** Gestion sécurisée des clés privées
|
||||
- **Compatibilité :** Support multi-réseaux (mainnet, testnet, signet)
|
||||
|
||||
### 2. Module Traits
|
||||
|
||||
**Rôle :** Définition des interfaces et contrats pour les opérations communes.
|
||||
|
||||
**Traits principaux :**
|
||||
|
||||
```rust
|
||||
// Opérations de wallet
|
||||
pub trait WalletOperations {
|
||||
fn generate_address(&self) -> Result<Address, SdkError>;
|
||||
fn sign_transaction(&self, tx: &Transaction) -> Result<Signature, SdkError>;
|
||||
fn verify_signature(&self, sig: &Signature, msg: &[u8]) -> bool;
|
||||
}
|
||||
|
||||
// Opérations de paiement silencieux
|
||||
pub trait SilentPaymentOperations {
|
||||
fn generate_payment(&self, wallet: &Wallet) -> Result<SilentPayment, SdkError>;
|
||||
fn scan_transaction(&self, tx: &Transaction) -> Result<Vec<Output>, SdkError>;
|
||||
fn create_output(&self, amount: u64) -> Result<TxOut, SdkError>;
|
||||
}
|
||||
|
||||
// Opérations réseau
|
||||
pub trait NetworkOperations {
|
||||
fn connect(&self, endpoint: &str) -> Result<Connection, SdkError>;
|
||||
fn send_message(&self, msg: &Message) -> Result<(), SdkError>;
|
||||
fn receive_message(&self) -> Result<Message, SdkError>;
|
||||
}
|
||||
|
||||
// Gestion des erreurs
|
||||
pub trait ErrorOperations {
|
||||
fn to_sdk_error(self) -> SdkError;
|
||||
fn from_sdk_error(error: SdkError) -> Self;
|
||||
}
|
||||
```
|
||||
|
||||
**Caractéristiques :**
|
||||
- **Abstraction :** Interfaces génériques et réutilisables
|
||||
- **Extensibilité :** Facilite l'ajout de nouvelles implémentations
|
||||
- **Testabilité :** Permet le mocking pour les tests
|
||||
- **Flexibilité :** Support de différentes stratégies d'implémentation
|
||||
|
||||
### 3. Module Utils
|
||||
|
||||
**Rôle :** Utilitaires et fonctions helper pour les opérations communes.
|
||||
|
||||
**Fonctionnalités principales :**
|
||||
|
||||
```rust
|
||||
// Validation
|
||||
pub mod validation {
|
||||
pub fn is_valid_bitcoin_address(address: &str) -> bool;
|
||||
pub fn is_valid_transaction_hex(hex: &str) -> bool;
|
||||
pub fn is_valid_private_key(key: &str) -> bool;
|
||||
}
|
||||
|
||||
// Sérialisation
|
||||
pub mod serialization {
|
||||
pub fn to_json<T: Serialize>(value: &T) -> Result<String, SdkError>;
|
||||
pub fn from_json<T: DeserializeOwned>(json: &str) -> Result<T, SdkError>;
|
||||
pub fn to_hex(bytes: &[u8]) -> String;
|
||||
pub fn from_hex(hex: &str) -> Result<Vec<u8>, SdkError>;
|
||||
}
|
||||
|
||||
// Cryptographie
|
||||
pub mod crypto {
|
||||
pub fn sha256(data: &[u8]) -> [u8; 32];
|
||||
pub fn ripemd160(data: &[u8]) -> [u8; 20];
|
||||
pub fn hmac_sha256(key: &[u8], data: &[u8]) -> [u8; 32];
|
||||
pub fn generate_random_bytes(length: usize) -> Vec<u8>;
|
||||
}
|
||||
|
||||
// Encodage
|
||||
pub mod encoding {
|
||||
pub fn base58_encode(data: &[u8]) -> String;
|
||||
pub fn base58_decode(encoded: &str) -> Result<Vec<u8>, SdkError>;
|
||||
pub fn bech32_encode(hrp: &str, data: &[u8]) -> Result<String, SdkError>;
|
||||
pub fn bech32_decode(encoded: &str) -> Result<(String, Vec<u8>), SdkError>;
|
||||
}
|
||||
```
|
||||
|
||||
## Architecture des Silent Payments
|
||||
|
||||
### 1. Génération de Paiement Silencieux
|
||||
|
||||
```rust
|
||||
pub struct SilentPaymentGenerator {
|
||||
wallet: Wallet,
|
||||
network: Network,
|
||||
}
|
||||
|
||||
impl SilentPaymentGenerator {
|
||||
pub fn new(wallet: Wallet, network: Network) -> Self {
|
||||
Self { wallet, network }
|
||||
}
|
||||
|
||||
pub fn generate_payment(&self) -> Result<SilentPayment, SdkError> {
|
||||
// 1. Générer la clé de scan
|
||||
let scan_key = self.generate_scan_key()?;
|
||||
|
||||
// 2. Générer la clé de dépense
|
||||
let spend_key = self.generate_spend_key()?;
|
||||
|
||||
// 3. Créer l'adresse silencieuse
|
||||
let address = self.create_silent_address(&scan_key, &spend_key)?;
|
||||
|
||||
Ok(SilentPayment {
|
||||
scan_key,
|
||||
spend_key,
|
||||
address,
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Scan de Transactions
|
||||
|
||||
```rust
|
||||
pub struct TransactionScanner {
|
||||
scan_key: ScanKey,
|
||||
network: Network,
|
||||
}
|
||||
|
||||
impl TransactionScanner {
|
||||
pub fn scan_transaction(&self, tx: &Transaction) -> Result<Vec<Output>, SdkError> {
|
||||
let mut outputs = Vec::new();
|
||||
|
||||
for (index, output) in tx.outputs.iter().enumerate() {
|
||||
// 1. Extraire les données de l'output
|
||||
let script_pubkey = &output.script_pubkey;
|
||||
|
||||
// 2. Vérifier si c'est un paiement silencieux
|
||||
if self.is_silent_payment_output(script_pubkey)? {
|
||||
// 3. Dériver la clé de scan
|
||||
let derived_key = self.derive_scan_key(script_pubkey)?;
|
||||
|
||||
// 4. Vérifier la correspondance
|
||||
if self.matches_scan_key(&derived_key)? {
|
||||
outputs.push(Output {
|
||||
txid: tx.txid.clone(),
|
||||
index: index as u32,
|
||||
amount: output.value,
|
||||
script_pubkey: script_pubkey.clone(),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(outputs)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Création de Sorties
|
||||
|
||||
```rust
|
||||
pub struct OutputCreator {
|
||||
spend_key: SpendKey,
|
||||
network: Network,
|
||||
}
|
||||
|
||||
impl OutputCreator {
|
||||
pub fn create_output(&self, amount: u64, address: &Address) -> Result<TxOut, SdkError> {
|
||||
// 1. Créer le script de sortie
|
||||
let script_pubkey = self.create_output_script(address)?;
|
||||
|
||||
// 2. Créer la sortie
|
||||
Ok(TxOut {
|
||||
value: amount,
|
||||
script_pubkey,
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Architecture de Sécurité
|
||||
|
||||
### 1. Gestion des Clés
|
||||
|
||||
```rust
|
||||
pub struct SecureKeyManager {
|
||||
private_key: SecureKey,
|
||||
public_key: PublicKey,
|
||||
}
|
||||
|
||||
impl SecureKeyManager {
|
||||
pub fn new() -> Result<Self, SdkError> {
|
||||
// Générer une clé privée sécurisée
|
||||
let private_key = SecureKey::generate()?;
|
||||
let public_key = private_key.public_key()?;
|
||||
|
||||
Ok(Self {
|
||||
private_key,
|
||||
public_key,
|
||||
})
|
||||
}
|
||||
|
||||
pub fn sign(&self, message: &[u8]) -> Result<Signature, SdkError> {
|
||||
// Signature sécurisée avec protection contre les attaques par timing
|
||||
self.private_key.sign_secure(message)
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for SecureKeyManager {
|
||||
fn drop(&mut self) {
|
||||
// Effacer la clé privée de la mémoire
|
||||
self.private_key.zeroize();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Validation des Entrées
|
||||
|
||||
```rust
|
||||
pub struct InputValidator {
|
||||
network: Network,
|
||||
max_tx_size: usize,
|
||||
}
|
||||
|
||||
impl InputValidator {
|
||||
pub fn validate_transaction(&self, tx: &Transaction) -> Result<(), SdkError> {
|
||||
// 1. Vérifier la taille
|
||||
if tx.serialized_size() > self.max_tx_size {
|
||||
return Err(SdkError::TransactionTooLarge);
|
||||
}
|
||||
|
||||
// 2. Vérifier les entrées
|
||||
for input in &tx.inputs {
|
||||
self.validate_input(input)?;
|
||||
}
|
||||
|
||||
// 3. Vérifier les sorties
|
||||
for output in &tx.outputs {
|
||||
self.validate_output(output)?;
|
||||
}
|
||||
|
||||
// 4. Vérifier la cohérence
|
||||
self.validate_consistency(tx)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Protection contre les Attaques
|
||||
|
||||
```rust
|
||||
pub struct SecurityManager {
|
||||
rate_limiter: RateLimiter,
|
||||
input_sanitizer: InputSanitizer,
|
||||
}
|
||||
|
||||
impl SecurityManager {
|
||||
pub fn process_request(&self, request: &Request) -> Result<Response, SdkError> {
|
||||
// 1. Rate limiting
|
||||
self.rate_limiter.check_limit(&request.source)?;
|
||||
|
||||
// 2. Sanitisation des entrées
|
||||
let sanitized_request = self.input_sanitizer.sanitize(request)?;
|
||||
|
||||
// 3. Validation
|
||||
self.validate_request(&sanitized_request)?;
|
||||
|
||||
// 4. Traitement sécurisé
|
||||
self.process_secure(&sanitized_request)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Architecture de Performance
|
||||
|
||||
### 1. Optimisations Rust
|
||||
|
||||
```rust
|
||||
// Utilisation de references pour éviter les copies
|
||||
pub fn process_wallet_optimized(wallet: &Wallet) -> Result<(), SdkError> {
|
||||
// Traitement sans copie
|
||||
wallet.process_transactions()?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// Utilisation de iterators pour les performances
|
||||
pub fn process_transactions_batch(txs: &[Transaction]) -> Vec<Result<(), SdkError>> {
|
||||
txs.iter()
|
||||
.map(|tx| process_transaction(tx))
|
||||
.collect()
|
||||
}
|
||||
|
||||
// Utilisation de Box pour les gros objets
|
||||
pub fn create_large_wallet() -> Box<Wallet> {
|
||||
Box::new(Wallet::new().unwrap())
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Optimisations WASM
|
||||
|
||||
```rust
|
||||
#[cfg(feature = "wasm")]
|
||||
pub mod wasm_optimizations {
|
||||
use wasm_bindgen::prelude::*;
|
||||
|
||||
// Utilisation de Web Workers pour les calculs lourds
|
||||
#[wasm_bindgen]
|
||||
pub fn process_payment_async(payment_data: JsValue) -> js_sys::Promise {
|
||||
// Traitement asynchrone
|
||||
wasm_bindgen_futures::JsFuture::from(
|
||||
process_payment_worker(payment_data)
|
||||
).into()
|
||||
}
|
||||
|
||||
// Utilisation de SharedArrayBuffer pour les gros datasets
|
||||
#[wasm_bindgen]
|
||||
pub fn process_large_dataset(data: &js_sys::Uint8Array) -> Result<(), JsValue> {
|
||||
// Traitement optimisé pour WASM
|
||||
process_data_optimized(data)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Cache et Mémoire
|
||||
|
||||
```rust
|
||||
pub struct CacheManager {
|
||||
wallet_cache: LruCache<String, Wallet>,
|
||||
tx_cache: LruCache<Txid, Transaction>,
|
||||
}
|
||||
|
||||
impl CacheManager {
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
wallet_cache: LruCache::new(100),
|
||||
tx_cache: LruCache::new(1000),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_wallet(&mut self, id: &str) -> Option<&Wallet> {
|
||||
self.wallet_cache.get(id)
|
||||
}
|
||||
|
||||
pub fn cache_wallet(&mut self, id: String, wallet: Wallet) {
|
||||
self.wallet_cache.put(id, wallet);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Architecture de Monitoring
|
||||
|
||||
### 1. Métriques de Performance
|
||||
|
||||
```rust
|
||||
pub struct PerformanceMetrics {
|
||||
operation_times: HashMap<String, Duration>,
|
||||
error_counts: HashMap<String, u64>,
|
||||
memory_usage: MemoryTracker,
|
||||
}
|
||||
|
||||
impl PerformanceMetrics {
|
||||
pub fn record_operation(&mut self, operation: &str, duration: Duration) {
|
||||
self.operation_times.insert(operation.to_string(), duration);
|
||||
}
|
||||
|
||||
pub fn record_error(&mut self, error_type: &str) {
|
||||
*self.error_counts.entry(error_type.to_string()).or_insert(0) += 1;
|
||||
}
|
||||
|
||||
pub fn get_memory_usage(&self) -> MemoryUsage {
|
||||
self.memory_usage.current_usage()
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Logs et Debug
|
||||
|
||||
```rust
|
||||
pub struct Logger {
|
||||
level: LogLevel,
|
||||
output: Box<dyn LogOutput>,
|
||||
}
|
||||
|
||||
impl Logger {
|
||||
pub fn log(&self, level: LogLevel, message: &str) {
|
||||
if level >= self.level {
|
||||
self.output.write(level, message);
|
||||
}
|
||||
}
|
||||
|
||||
pub fn debug(&self, message: &str) {
|
||||
self.log(LogLevel::Debug, message);
|
||||
}
|
||||
|
||||
pub fn info(&self, message: &str) {
|
||||
self.log(LogLevel::Info, message);
|
||||
}
|
||||
|
||||
pub fn error(&self, message: &str) {
|
||||
self.log(LogLevel::Error, message);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Architecture de Déploiement
|
||||
|
||||
### 1. Support Multi-Plateforme
|
||||
|
||||
```rust
|
||||
// Configuration conditionnelle pour différentes plateformes
|
||||
#[cfg(target_arch = "wasm32")]
|
||||
pub mod wasm_config {
|
||||
pub const MAX_MEMORY: usize = 32 * 1024 * 1024; // 32MB
|
||||
pub const STACK_SIZE: usize = 1024 * 1024; // 1MB
|
||||
}
|
||||
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
pub mod native_config {
|
||||
pub const MAX_MEMORY: usize = 1024 * 1024 * 1024; // 1GB
|
||||
pub const STACK_SIZE: usize = 8 * 1024 * 1024; // 8MB
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Features Conditionnelles
|
||||
|
||||
```rust
|
||||
// Features pour différentes configurations
|
||||
#[cfg(feature = "std")]
|
||||
pub mod std_support {
|
||||
pub use std::collections::HashMap;
|
||||
pub use std::time::Instant;
|
||||
}
|
||||
|
||||
#[cfg(feature = "wasm")]
|
||||
pub mod wasm_support {
|
||||
pub use js_sys::Object;
|
||||
pub use wasm_bindgen::prelude::*;
|
||||
}
|
||||
|
||||
#[cfg(feature = "blindbit-wasm")]
|
||||
pub mod blindbit_wasm {
|
||||
pub use js_sys;
|
||||
pub use web_sys;
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Intégration CI/CD
|
||||
|
||||
```rust
|
||||
// Tests conditionnels pour différents environnements
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn test_wallet_creation() {
|
||||
// Test de base
|
||||
}
|
||||
|
||||
#[cfg(feature = "wasm")]
|
||||
#[test]
|
||||
fn test_wasm_integration() {
|
||||
// Test WASM
|
||||
}
|
||||
|
||||
#[cfg(feature = "blindbit-wasm")]
|
||||
#[test]
|
||||
fn test_blindbit_wasm() {
|
||||
// Test Blindbit WASM
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Évolutions Futures
|
||||
|
||||
### 1. Extensions Planifiées
|
||||
|
||||
- **Support de nouveaux réseaux** : Lightning Network, Liquid
|
||||
- **Optimisations avancées** : SIMD, GPU acceleration
|
||||
- **Nouvelles fonctionnalités** : Multi-signature, Time-locks
|
||||
- **Intégrations** : Support de nouveaux wallets et services
|
||||
|
||||
### 2. Améliorations de Performance
|
||||
|
||||
- **Compilation JIT** : Optimisations dynamiques
|
||||
- **Parallélisation** : Support multi-threading avancé
|
||||
- **Cache intelligent** : Cache adaptatif basé sur l'usage
|
||||
- **Compression** : Optimisation de la taille des données
|
||||
|
||||
### 3. Sécurité Renforcée
|
||||
|
||||
- **Audit de sécurité** : Vérifications automatisées
|
||||
- **Isolation mémoire** : Protection avancée contre les attaques
|
||||
- **Chiffrement** : Support de nouveaux algorithmes
|
||||
- **Validation** : Vérifications supplémentaires
|
||||
|
||||
---
|
||||
|
||||
**🏗️ Architecture sdk_common - Fondation solide pour les Silent Payments** 🚀
|
||||
@ -1,401 +0,0 @@
|
||||
# Guide de la Communauté - 4NK Node
|
||||
|
||||
## 🌟 Bienvenue dans la Communauté 4NK Node !
|
||||
|
||||
Ce guide vous accompagne dans votre participation à la communauté open source de 4NK Node, une infrastructure complète pour les paiements silencieux Bitcoin.
|
||||
|
||||
## 🎯 À Propos de 4NK Node
|
||||
|
||||
### **Qu'est-ce que 4NK Node ?**
|
||||
|
||||
4NK Node est une infrastructure Docker complète qui permet de déployer et gérer facilement un écosystème Bitcoin complet incluant :
|
||||
|
||||
- **Bitcoin Core** : Nœud Bitcoin avec support signet
|
||||
- **Blindbit** : Service de filtres pour les paiements silencieux
|
||||
- **SDK Relay** : Système de relais avec synchronisation mesh
|
||||
- **Tor** : Proxy anonyme pour la confidentialité
|
||||
|
||||
### **Pourquoi les Paiements Silencieux ?**
|
||||
|
||||
Les paiements silencieux (Silent Payments) sont une innovation Bitcoin qui améliore la confidentialité en permettant de créer des adresses uniques pour chaque transaction, sans révéler de liens entre les paiements.
|
||||
|
||||
## 🤝 Comment Contribuer
|
||||
|
||||
### **Niveaux de Contribution**
|
||||
|
||||
#### 🟢 **Débutant**
|
||||
- **Documentation** : Améliorer les guides, corriger les fautes
|
||||
- **Tests** : Ajouter des tests, signaler des bugs
|
||||
- **Support** : Aider les autres utilisateurs
|
||||
- **Traduction** : Traduire la documentation
|
||||
|
||||
#### 🟡 **Intermédiaire**
|
||||
- **Fonctionnalités** : Implémenter de nouvelles fonctionnalités
|
||||
- **Optimisations** : Améliorer les performances
|
||||
- **Tests avancés** : Tests d'intégration et de performance
|
||||
- **Outils** : Créer des scripts et outils
|
||||
|
||||
#### 🔴 **Avancé**
|
||||
- **Architecture** : Améliorer l'architecture du système
|
||||
- **Sécurité** : Audits de sécurité, améliorations
|
||||
- **Core features** : Fonctionnalités principales
|
||||
- **Mentorat** : Guider les nouveaux contributeurs
|
||||
|
||||
### **Premiers Pas**
|
||||
|
||||
#### 1. **Fork et Clone**
|
||||
```bash
|
||||
# Fork le repository sur Gitea
|
||||
# Puis clonez votre fork
|
||||
git clone https://git.4nkweb.com/votre-username/4NK_node.git
|
||||
cd 4NK_node
|
||||
|
||||
# Ajoutez l'upstream
|
||||
git remote add upstream https://git.4nkweb.com/4nk/4NK_node.git
|
||||
```
|
||||
|
||||
#### 2. **Installation Locale**
|
||||
```bash
|
||||
# Installez l'infrastructure
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Vérifiez que tout fonctionne
|
||||
docker ps
|
||||
```
|
||||
|
||||
#### 3. **Exploration**
|
||||
```bash
|
||||
# Explorez la documentation
|
||||
ls docs/
|
||||
cat docs/INDEX.md
|
||||
|
||||
# Exécutez les tests
|
||||
./tests/run_all_tests.sh
|
||||
```
|
||||
|
||||
## 📚 Ressources d'Apprentissage
|
||||
|
||||
### **Documentation Essentielle**
|
||||
|
||||
#### **Pour Commencer**
|
||||
- **[Guide d'Installation](INSTALLATION.md)** - Installation complète
|
||||
- **[Guide d'Utilisation](USAGE.md)** - Utilisation quotidienne
|
||||
- **[Guide de Configuration](CONFIGURATION.md)** - Configuration avancée
|
||||
|
||||
#### **Pour Développer**
|
||||
- **[Architecture Technique](ARCHITECTURE.md)** - Architecture détaillée
|
||||
- **[API Reference](API.md)** - Documentation des APIs
|
||||
- **[Guide de Tests](TESTING.md)** - Tests et validation
|
||||
|
||||
#### **Pour Contribuer**
|
||||
- **[Guide de Contribution](../CONTRIBUTING.md)** - Processus de contribution
|
||||
- **[Code de Conduite](../CODE_OF_CONDUCT.md)** - Règles de la communauté
|
||||
- **[Politique de Sécurité](SECURITY.md)** - Signalement de vulnérabilités
|
||||
|
||||
### **Ressources Externes**
|
||||
|
||||
#### **Bitcoin et Paiements Silencieux**
|
||||
- [Bitcoin.org](https://bitcoin.org/) - Documentation Bitcoin officielle
|
||||
- [BIP 352](https://github.com/bitcoin/bips/blob/master/bip-0352.mediawiki) - Spécification des paiements silencieux
|
||||
- [Bitcoin Core Documentation](https://bitcoincore.org/en/doc/) - Documentation Bitcoin Core
|
||||
|
||||
#### **Technologies Utilisées**
|
||||
- [Docker Documentation](https://docs.docker.com/) - Guide Docker
|
||||
- [Rust Book](https://doc.rust-lang.org/book/) - Guide Rust
|
||||
- [WebSocket RFC](https://tools.ietf.org/html/rfc6455) - Spécification WebSocket
|
||||
|
||||
## 🛠️ Environnement de Développement
|
||||
|
||||
### **Prérequis**
|
||||
|
||||
#### **Système**
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt update
|
||||
sudo apt install docker.io docker-compose git curl
|
||||
|
||||
# CentOS/RHEL
|
||||
sudo yum install docker docker-compose git curl
|
||||
|
||||
# macOS
|
||||
brew install docker docker-compose git curl
|
||||
```
|
||||
|
||||
#### **Développement**
|
||||
```bash
|
||||
# Rust (pour sdk_relay)
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
|
||||
# Python (pour les tests)
|
||||
sudo apt install python3 python3-pip
|
||||
pip3 install websockets requests
|
||||
```
|
||||
|
||||
### **Configuration de Développement**
|
||||
|
||||
#### **Variables d'Environnement**
|
||||
```bash
|
||||
# Configuration de développement
|
||||
export RUST_LOG=debug
|
||||
export ENABLE_SYNC_TEST=1
|
||||
export BITCOIN_NETWORK=signet
|
||||
```
|
||||
|
||||
#### **Outils de Développement**
|
||||
```bash
|
||||
# Linting et formatting
|
||||
cargo clippy
|
||||
cargo fmt
|
||||
|
||||
# Tests
|
||||
cargo test
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Build
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
## 🐛 Signaler un Bug
|
||||
|
||||
### **Avant de Signaler**
|
||||
|
||||
1. **Vérifiez la documentation** - La solution pourrait déjà être documentée
|
||||
2. **Recherchez les issues existantes** - Le bug pourrait déjà être signalé
|
||||
3. **Testez sur la dernière version** - Le bug pourrait déjà être corrigé
|
||||
|
||||
### **Template de Bug Report**
|
||||
|
||||
Utilisez le template fourni dans Gitea ou suivez cette structure :
|
||||
|
||||
```markdown
|
||||
## Description du Bug
|
||||
Description claire et concise du problème.
|
||||
|
||||
## Étapes pour Reproduire
|
||||
1. Aller à '...'
|
||||
2. Cliquer sur '...'
|
||||
3. Faire défiler jusqu'à '...'
|
||||
4. Voir l'erreur
|
||||
|
||||
## Comportement Attendu
|
||||
Description de ce qui devrait se passer.
|
||||
|
||||
## Comportement Actuel
|
||||
Description de ce qui se passe actuellement.
|
||||
|
||||
## Informations Système
|
||||
- OS: [ex: Ubuntu 20.04]
|
||||
- Docker: [ex: 20.10.0]
|
||||
- Version: [ex: v1.0.0]
|
||||
|
||||
## Logs
|
||||
```
|
||||
Logs pertinents ici
|
||||
```
|
||||
```
|
||||
|
||||
## 💡 Proposer une Fonctionnalité
|
||||
|
||||
### **Avant de Proposer**
|
||||
|
||||
1. **Vérifiez la roadmap** - La fonctionnalité pourrait déjà être planifiée
|
||||
2. **Discutez avec la communauté** - Utilisez les discussions Gitea
|
||||
3. **Préparez un prototype** - Montrez que c'est faisable
|
||||
|
||||
### **Template de Feature Request**
|
||||
|
||||
```markdown
|
||||
## Résumé
|
||||
Description claire et concise de la fonctionnalité souhaitée.
|
||||
|
||||
## Motivation
|
||||
Pourquoi cette fonctionnalité est-elle nécessaire ?
|
||||
|
||||
## Proposition
|
||||
Description détaillée de la fonctionnalité proposée.
|
||||
|
||||
## Alternatives Considérées
|
||||
Autres solutions envisagées.
|
||||
|
||||
## Exemples d'Utilisation
|
||||
Comment cette fonctionnalité serait-elle utilisée ?
|
||||
```
|
||||
|
||||
## 🔄 Processus de Contribution
|
||||
|
||||
### **Workflow Git**
|
||||
|
||||
#### 1. **Créer une Branche**
|
||||
```bash
|
||||
# Depuis la branche main
|
||||
git checkout main
|
||||
git pull upstream main
|
||||
|
||||
# Créer une branche pour votre contribution
|
||||
git checkout -b feature/nom-de-votre-feature
|
||||
# ou
|
||||
git checkout -b fix/nom-du-bug
|
||||
```
|
||||
|
||||
#### 2. **Développer**
|
||||
```bash
|
||||
# Développez votre fonctionnalité
|
||||
# Ajoutez des tests
|
||||
# Mettez à jour la documentation
|
||||
|
||||
# Commitez régulièrement
|
||||
git add .
|
||||
git commit -m "feat: ajouter nouvelle fonctionnalité"
|
||||
```
|
||||
|
||||
#### 3. **Tester**
|
||||
```bash
|
||||
# Exécutez les tests
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Vérifiez le code
|
||||
cargo clippy
|
||||
cargo fmt --check
|
||||
```
|
||||
|
||||
#### 4. **Soumettre**
|
||||
```bash
|
||||
# Poussez vers votre fork
|
||||
git push origin feature/nom-de-votre-feature
|
||||
|
||||
# Créez une Pull Request sur Gitea
|
||||
```
|
||||
|
||||
### **Standards de Code**
|
||||
|
||||
#### **Messages de Commit**
|
||||
Utilisez le format conventionnel :
|
||||
```bash
|
||||
feat(sdk_relay): add new sync type for metrics
|
||||
fix(bitcoin): resolve connection timeout issue
|
||||
docs(api): update WebSocket message format
|
||||
test(integration): add multi-relay sync tests
|
||||
```
|
||||
|
||||
#### **Code Style**
|
||||
- **Rust** : Suivez les conventions Rust (rustfmt, clippy)
|
||||
- **Bash** : Utilisez shellcheck pour les scripts
|
||||
- **Python** : Suivez PEP 8
|
||||
- **Markdown** : Utilisez un linter markdown
|
||||
|
||||
## 🏷️ Labels et Milestones
|
||||
|
||||
### **Labels Utilisés**
|
||||
|
||||
#### **Type**
|
||||
- `bug` - Problèmes et bugs
|
||||
- `enhancement` - Nouvelles fonctionnalités
|
||||
- `documentation` - Amélioration de la documentation
|
||||
- `good first issue` - Pour les nouveaux contributeurs
|
||||
- `help wanted` - Besoin d'aide
|
||||
|
||||
#### **Priorité**
|
||||
- `priority: high` - Priorité élevée
|
||||
- `priority: medium` - Priorité moyenne
|
||||
- `priority: low` - Priorité basse
|
||||
|
||||
#### **Statut**
|
||||
- `status: blocked` - Bloqué
|
||||
- `status: in progress` - En cours
|
||||
- `status: ready for review` - Prêt pour review
|
||||
|
||||
### **Milestones**
|
||||
|
||||
- **v1.0.0** - Version stable initiale
|
||||
- **v1.1.0** - Améliorations et corrections
|
||||
- **v2.0.0** - Nouvelles fonctionnalités majeures
|
||||
|
||||
## 🎉 Reconnaissance
|
||||
|
||||
### **Hall of Fame**
|
||||
|
||||
Les contributeurs significatifs seront reconnus dans :
|
||||
|
||||
- **README.md** - Liste des contributeurs
|
||||
- **CHANGELOG.md** - Mentions dans les releases
|
||||
- **Documentation** - Crédits dans les guides
|
||||
- **Site web** - Page dédiée aux contributeurs
|
||||
|
||||
### **Badges et Certifications**
|
||||
|
||||
- **Contributeur Bronze** : 1-5 contributions
|
||||
- **Contributeur Argent** : 6-20 contributions
|
||||
- **Contributeur Or** : 21+ contributions
|
||||
- **Maintainer** : Responsabilités de maintenance
|
||||
|
||||
## 🆘 Besoin d'Aide ?
|
||||
|
||||
### **Canaux de Support**
|
||||
|
||||
#### **Issues Gitea**
|
||||
- **Bugs** : [Issues](https://git.4nkweb.com/4nk/4NK_node/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
|
||||
- **Fonctionnalités** : [Feature Requests](https://git.4nkweb.com/4nk/4NK_node/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
|
||||
#### **Discussions**
|
||||
- **Questions générales** : [Discussions](https://git.4nkweb.com/4nk/4NK_node/issues)
|
||||
- **Aide technique** : [Support](https://git.4nkweb.com/4nk/4NK_node/issues/new)
|
||||
|
||||
#### **Contact Direct**
|
||||
- **Email** : support@4nkweb.com
|
||||
- **Sécurité** : security@4nkweb.com
|
||||
|
||||
### **FAQ**
|
||||
|
||||
#### **Questions Fréquentes**
|
||||
|
||||
**Q: Comment installer 4NK Node ?**
|
||||
A: Suivez le [Guide d'Installation](INSTALLATION.md)
|
||||
|
||||
**Q: Comment contribuer au code ?**
|
||||
A: Consultez le [Guide de Contribution](../CONTRIBUTING.md)
|
||||
|
||||
**Q: Comment signaler un bug de sécurité ?**
|
||||
A: Contactez security@4nkweb.com (NE PAS créer d'issue publique)
|
||||
|
||||
**Q: Comment proposer une nouvelle fonctionnalité ?**
|
||||
A: Créez une issue avec le label `enhancement`
|
||||
|
||||
## 🚀 Projets Futurs
|
||||
|
||||
### **Roadmap Communautaire**
|
||||
|
||||
#### **Court Terme (1-3 mois)**
|
||||
- Interface utilisateur web
|
||||
- Support de nouveaux réseaux Bitcoin
|
||||
- Amélioration de la documentation
|
||||
- Tests de performance
|
||||
|
||||
#### **Moyen Terme (3-6 mois)**
|
||||
- Support Lightning Network
|
||||
- API REST complète
|
||||
- Monitoring avancé
|
||||
- Déploiement cloud
|
||||
|
||||
#### **Long Terme (6-12 mois)**
|
||||
- Écosystème complet
|
||||
- Marketplace d'extensions
|
||||
- Support multi-blockchains
|
||||
- IA et automatisation
|
||||
|
||||
### **Idées de Contribution**
|
||||
|
||||
#### **Fonctionnalités Populaires**
|
||||
- Interface graphique pour la gestion
|
||||
- Intégration avec des wallets populaires
|
||||
- Support de nouveaux types de paiements
|
||||
- Outils de monitoring avancés
|
||||
|
||||
#### **Améliorations Techniques**
|
||||
- Optimisation des performances
|
||||
- Amélioration de la sécurité
|
||||
- Support de nouvelles plateformes
|
||||
- Tests automatisés avancés
|
||||
|
||||
---
|
||||
|
||||
**Merci de faire partie de la communauté 4NK Node ! Votre contribution aide à construire l'avenir des paiements Bitcoin privés et sécurisés.** 🌟
|
||||
@ -1,846 +0,0 @@
|
||||
# ⚙️ Guide de Configuration - 4NK Node
|
||||
|
||||
Guide complet pour configurer l'infrastructure 4NK Node selon vos besoins.
|
||||
|
||||
## 📋 Configuration Générale
|
||||
|
||||
### 1. Variables d'Environnement
|
||||
|
||||
Créer un fichier `.env` à la racine du projet :
|
||||
|
||||
```bash
|
||||
# Configuration 4NK Node
|
||||
PROJECT_NAME=4NK Node
|
||||
NETWORK_NAME=4nk_node_btcnet
|
||||
|
||||
# Logs
|
||||
RUST_LOG=debug,bitcoincore_rpc=trace
|
||||
|
||||
# Bitcoin
|
||||
BITCOIN_COOKIE_PATH=/home/bitcoin/.bitcoin/signet/.cookie
|
||||
|
||||
# Synchronisation
|
||||
ENABLE_SYNC_TEST=1
|
||||
|
||||
# Ports
|
||||
TOR_PORTS=9050:9050,9051:9051
|
||||
BITCOIN_PORTS=38333:38333,18443:18443,29000:29000
|
||||
BLINDBIT_PORTS=8000:8000
|
||||
RELAY_1_PORTS=8090:8090,8091:8091
|
||||
RELAY_2_PORTS=8092:8090,8093:8091
|
||||
RELAY_3_PORTS=8094:8090,8095:8091
|
||||
```
|
||||
|
||||
### 2. Configuration Réseau
|
||||
|
||||
#### Réseau Docker Personnalisé
|
||||
|
||||
```bash
|
||||
# Créer un réseau personnalisé
|
||||
docker network create 4nk-network --subnet=172.20.0.0/16 --gateway=172.20.0.1
|
||||
|
||||
# Modifier docker-compose.yml
|
||||
sed -i 's/4nk_default/4nk-network/g' docker-compose.yml
|
||||
```
|
||||
|
||||
#### Configuration de Pare-feu
|
||||
|
||||
```bash
|
||||
# Autoriser les ports nécessaires
|
||||
sudo ufw allow 18443/tcp # Bitcoin Core RPC
|
||||
sudo ufw allow 8090/tcp # sdk_relay WebSocket
|
||||
sudo ufw allow 8000/tcp # Blindbit API
|
||||
sudo ufw allow 9050/tcp # Tor SOCKS
|
||||
sudo ufw enable
|
||||
|
||||
# Vérifier les règles
|
||||
sudo ufw status numbered
|
||||
```
|
||||
|
||||
## 🔧 Configuration Bitcoin Core
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
Fichier : `bitcoin/bitcoin.conf`
|
||||
|
||||
```ini
|
||||
# Configuration Bitcoin Core Signet
|
||||
signet=1
|
||||
rpcuser=bitcoin
|
||||
rpcpassword=your_secure_password
|
||||
rpcbind=0.0.0.0
|
||||
rpcallowip=172.19.0.0/16
|
||||
zmqpubrawblock=tcp://0.0.0.0:29000
|
||||
zmqpubrawtx=tcp://0.0.0.0:29000
|
||||
txindex=1
|
||||
server=1
|
||||
listen=1
|
||||
|
||||
# Configuration Signet
|
||||
[signet]
|
||||
listen=1
|
||||
bind=0.0.0.0:38333
|
||||
rpcbind=0.0.0.0:18443
|
||||
rpcport=18443
|
||||
fallbackfee=0.0001
|
||||
blockfilterindex=1
|
||||
datacarriersize=205
|
||||
acceptnonstdtxn=1
|
||||
dustrelayfee=0.00000001
|
||||
minrelaytxfee=0.00000001
|
||||
prune=0
|
||||
signetchallenge=0020341c43803863c252df326e73574a27d7e19322992061017b0dc893e2eab90821
|
||||
walletdir=/home/bitcoin/.bitcoin/wallets
|
||||
wallet=mining
|
||||
wallet=watchonly
|
||||
maxtxfee=1
|
||||
addnode=tlv2yqamflv22vfdzy2hha2nwmt6zrwrhjjzz4lx7qyq7lyc6wfhabyd.onion
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Performance
|
||||
|
||||
```ini
|
||||
# Optimisation mémoire
|
||||
dbcache=450
|
||||
maxmempool=300
|
||||
maxconnections=125
|
||||
|
||||
# Optimisation disque
|
||||
txindex=1
|
||||
blockfilterindex=1
|
||||
coinstatsindex=1
|
||||
|
||||
# Optimisation réseau
|
||||
listenonion=1
|
||||
onion=tor:9050
|
||||
proxy=tor:9050
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```ini
|
||||
# Authentification
|
||||
rpcauth=bitcoin:c8ea921c7357bd6a5a8a7c43a12350a7$955e25b17672987b17c5a12f12cd8b9c1d38f0f86201c8cd47fc431f2e1c7956
|
||||
rpcallowip=172.19.0.0/16
|
||||
rpcworkqueue=32
|
||||
rpcthreads=4
|
||||
rpcdoccheck=1
|
||||
|
||||
# Limites
|
||||
maxuploadtarget=5000
|
||||
maxconnections=125
|
||||
```
|
||||
|
||||
### 3. Configuration des Wallets
|
||||
|
||||
```bash
|
||||
# Créer un wallet pour les relais
|
||||
docker exec bitcoin-signet bitcoin-cli -signet createwallet "relay_wallet"
|
||||
|
||||
# Créer un wallet pour le mining
|
||||
docker exec bitcoin-signet bitcoin-cli -signet createwallet "mining_wallet"
|
||||
|
||||
# Créer un wallet watch-only
|
||||
docker exec bitcoin-signet bitcoin-cli -signet createwallet "watchonly_wallet" true
|
||||
```
|
||||
|
||||
## 🔧 Configuration Blindbit
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
Fichier : `blindbit/blindbit.toml`
|
||||
|
||||
```toml
|
||||
# Configuration Blindbit Oracle
|
||||
host = "0.0.0.0:8000"
|
||||
chain = "signet"
|
||||
rpc_endpoint = "http://bitcoin:18443"
|
||||
cookie_path = "/home/bitcoin/.bitcoin/signet/.cookie"
|
||||
rpc_user = ""
|
||||
rpc_pass = ""
|
||||
sync_start_height = 1
|
||||
|
||||
# Performance
|
||||
max_parallel_tweak_computations = 4
|
||||
max_parallel_requests = 4
|
||||
|
||||
# Index
|
||||
tweaks_only = 0
|
||||
tweaks_full_basic = 1
|
||||
tweaks_full_with_dust_filter = 1
|
||||
tweaks_cut_through_with_dust_filter = 1
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Performance
|
||||
|
||||
```toml
|
||||
# Optimisation des calculs
|
||||
max_parallel_tweak_computations = 8
|
||||
max_parallel_requests = 8
|
||||
|
||||
# Cache
|
||||
cache_size = 1000
|
||||
cache_ttl = 3600
|
||||
|
||||
# Logs
|
||||
log_level = "info"
|
||||
log_file = "/data/blindbit.log"
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```toml
|
||||
# Authentification
|
||||
rpc_user = "blindbit_user"
|
||||
rpc_pass = "secure_password"
|
||||
|
||||
# Limites
|
||||
max_request_size = 1048576
|
||||
rate_limit = 100
|
||||
```
|
||||
|
||||
## 🔧 Configuration des Relais
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
#### Relay 1 - `sdk_relay/.conf.docker.relay1`
|
||||
|
||||
```ini
|
||||
core_url=http://bitcoin:18443
|
||||
core_wallet=relay_wallet
|
||||
ws_url=0.0.0.0:8090
|
||||
wallet_name=relay_wallet.json
|
||||
network=signet
|
||||
blindbit_url=http://blindbit:8000
|
||||
zmq_url=tcp://bitcoin:29000
|
||||
data_dir=.4nk
|
||||
cookie_path=/home/bitcoin/.4nk/bitcoin.cookie
|
||||
dev_mode=true
|
||||
standalone=false
|
||||
relay_id=relay-1
|
||||
```
|
||||
|
||||
#### Relay 2 - `sdk_relay/.conf.docker.relay2`
|
||||
|
||||
```ini
|
||||
core_url=http://bitcoin:18443
|
||||
core_wallet=relay_wallet
|
||||
ws_url=0.0.0.0:8090
|
||||
wallet_name=relay_wallet.json
|
||||
network=signet
|
||||
blindbit_url=http://blindbit:8000
|
||||
zmq_url=tcp://bitcoin:29000
|
||||
data_dir=.4nk
|
||||
cookie_path=/home/bitcoin/.4nk/bitcoin.cookie
|
||||
dev_mode=true
|
||||
standalone=false
|
||||
relay_id=relay-2
|
||||
```
|
||||
|
||||
#### Relay 3 - `sdk_relay/.conf.docker.relay3`
|
||||
|
||||
```ini
|
||||
core_url=http://bitcoin:18443
|
||||
core_wallet=relay_wallet
|
||||
ws_url=0.0.0.0:8090
|
||||
wallet_name=relay_wallet.json
|
||||
network=signet
|
||||
blindbit_url=http://blindbit:8000
|
||||
zmq_url=tcp://bitcoin:29000
|
||||
data_dir=.4nk
|
||||
cookie_path=/home/bitcoin/.4nk/bitcoin.cookie
|
||||
dev_mode=true
|
||||
standalone=false
|
||||
relay_id=relay-3
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Performance
|
||||
|
||||
```ini
|
||||
# Optimisation mémoire
|
||||
max_connections=100
|
||||
connection_timeout=30
|
||||
read_timeout=60
|
||||
|
||||
# Cache
|
||||
cache_size=1000
|
||||
cache_ttl=3600
|
||||
|
||||
# Logs
|
||||
log_level=info
|
||||
log_file=/home/bitcoin/.4nk/relay.log
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```ini
|
||||
# Authentification
|
||||
auth_required=true
|
||||
auth_token=your_secure_token
|
||||
|
||||
# Limites
|
||||
max_message_size=1048576
|
||||
rate_limit=1000
|
||||
```
|
||||
|
||||
### 3. Configuration de Synchronisation
|
||||
|
||||
```ini
|
||||
# Synchronisation
|
||||
sync_enabled=true
|
||||
sync_interval=30
|
||||
sync_timeout=10
|
||||
|
||||
# Découverte
|
||||
discovery_enabled=true
|
||||
discovery_interval=60
|
||||
discovery_timeout=5
|
||||
|
||||
# Cache de déduplication
|
||||
dedup_enabled=true
|
||||
dedup_ttl=300
|
||||
dedup_max_size=10000
|
||||
```
|
||||
|
||||
## 🌐 Configuration des Nœuds Externes
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
Fichier : `sdk_relay/external_nodes.conf`
|
||||
|
||||
```toml
|
||||
# Configuration des nœuds externes
|
||||
[relays]
|
||||
external-relay-1 = "external-relay-1.example.com:8090"
|
||||
external-relay-2 = "192.168.1.100:8090"
|
||||
dev3-relay = "dev3.4nkweb.com:443"
|
||||
|
||||
[discovery]
|
||||
auto_discover = true
|
||||
bootstrap_nodes = [
|
||||
"bootstrap-1.4nk.net:8090",
|
||||
"bootstrap-2.4nk.net:8090"
|
||||
]
|
||||
|
||||
[security]
|
||||
allowed_domains = [
|
||||
"*.4nk.net",
|
||||
"*.example.com",
|
||||
"localhost",
|
||||
"127.0.0.1"
|
||||
]
|
||||
|
||||
[validation]
|
||||
max_connection_timeout = 10
|
||||
health_check_interval = 300
|
||||
blacklist_threshold = 5
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Découverte Automatique
|
||||
|
||||
```toml
|
||||
[discovery]
|
||||
auto_discover = true
|
||||
bootstrap_nodes = [
|
||||
"bootstrap-1.4nk.net:8090",
|
||||
"bootstrap-2.4nk.net:8090"
|
||||
]
|
||||
discovery_interval = 300
|
||||
discovery_timeout = 10
|
||||
max_discovered_nodes = 50
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```toml
|
||||
[security]
|
||||
allowed_domains = [
|
||||
"*.4nk.net",
|
||||
"*.example.com",
|
||||
"localhost",
|
||||
"127.0.0.1"
|
||||
]
|
||||
blocked_domains = [
|
||||
"malicious.example.com"
|
||||
]
|
||||
allowed_ips = [
|
||||
"192.168.1.0/24",
|
||||
"10.0.0.0/8"
|
||||
]
|
||||
```
|
||||
|
||||
#### Validation
|
||||
|
||||
```toml
|
||||
[validation]
|
||||
max_connection_timeout = 10
|
||||
health_check_interval = 300
|
||||
blacklist_threshold = 5
|
||||
whitelist_enabled = false
|
||||
certificate_verification = true
|
||||
```
|
||||
|
||||
## 🔧 Configuration Tor
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
Fichier : `tor/torrc`
|
||||
|
||||
```ini
|
||||
# Configuration Tor
|
||||
SocksPort 9050
|
||||
ControlPort 9051
|
||||
DataDirectory /var/lib/tor
|
||||
PidFile /var/run/tor/tor.pid
|
||||
|
||||
# Logs
|
||||
Log notice file /var/log/tor/notices.log
|
||||
Log info file /var/log/tor/info.log
|
||||
|
||||
# Sécurité
|
||||
CookieAuthentication 1
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Performance
|
||||
|
||||
```ini
|
||||
# Optimisation réseau
|
||||
MaxCircuitDirtiness 600
|
||||
MaxClientCircuitsPending 32
|
||||
EnforceDistinctSubnets 1
|
||||
|
||||
# Cache
|
||||
MaxMemInQueues 64 MB
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```ini
|
||||
# Authentification
|
||||
CookieAuthentication 1
|
||||
ControlPort 9051
|
||||
|
||||
# Limites
|
||||
MaxConnections 1000
|
||||
MaxConnectionsEntry 100
|
||||
```
|
||||
|
||||
## 🔧 Configuration Docker Compose
|
||||
|
||||
### 1. Configuration de Base
|
||||
|
||||
Fichier : `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
tor:
|
||||
image: dperson/torproxy:latest
|
||||
container_name: tor-proxy
|
||||
networks:
|
||||
btcnet:
|
||||
aliases:
|
||||
- tor
|
||||
ports:
|
||||
- "9050:9050"
|
||||
- "9051:9051"
|
||||
restart: unless-stopped
|
||||
|
||||
bitcoin:
|
||||
build: ./bitcoin
|
||||
container_name: bitcoin-signet
|
||||
depends_on:
|
||||
- tor
|
||||
volumes:
|
||||
- bitcoin_data:/home/bitcoin/.bitcoin
|
||||
- ./bitcoin/bitcoin.conf:/home/bitcoin/.bitcoin/bitcoin.conf
|
||||
ports:
|
||||
- "38333:38333"
|
||||
- "18443:18443"
|
||||
- "29000:29000"
|
||||
networks:
|
||||
btcnet:
|
||||
aliases:
|
||||
- bitcoin
|
||||
environment:
|
||||
- TOR_HOST=tor
|
||||
- TOR_PORT=9050
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "bitcoin-cli", "-conf=/home/bitcoin/.bitcoin/bitcoin.conf", "getblockchaininfo"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
blindbit:
|
||||
build: ./blindbit
|
||||
container_name: blindbit-oracle
|
||||
depends_on:
|
||||
- bitcoin
|
||||
volumes:
|
||||
- blindbit_data:/data
|
||||
- ./blindbit/blindbit.toml:/data/blindbit.toml
|
||||
- bitcoin_data:/home/bitcoin/.bitcoin
|
||||
ports:
|
||||
- "8000:8000"
|
||||
networks:
|
||||
btcnet:
|
||||
aliases:
|
||||
- blindbit
|
||||
restart: unless-stopped
|
||||
|
||||
sdk_relay_1:
|
||||
build:
|
||||
context: ..
|
||||
dockerfile: 4NK_node/sdk_relay/Dockerfile
|
||||
container_name: sdk_relay_1
|
||||
depends_on:
|
||||
bitcoin:
|
||||
condition: service_healthy
|
||||
blindbit:
|
||||
condition: service_started
|
||||
volumes:
|
||||
- bitcoin_data:/home/bitcoin/.bitcoin
|
||||
- ./bitcoin/bitcoin.conf:/home/bitcoin/.bitcoin/bitcoin.conf
|
||||
- sdk_relay_1_data:/home/bitcoin/.4nk
|
||||
- ./sdk_relay/.conf.docker.relay1:/home/bitcoin/.conf.docker
|
||||
- ./sdk_relay/external_nodes.conf:/home/bitcoin/.4nk/external_nodes.conf
|
||||
ports:
|
||||
- "8090:8090"
|
||||
- "8091:8091"
|
||||
networks:
|
||||
btcnet:
|
||||
aliases:
|
||||
- sdk_relay_1
|
||||
environment:
|
||||
- RUST_LOG=debug,bitcoincore_rpc=trace
|
||||
- HOME=/home/bitcoin
|
||||
- BITCOIN_COOKIE_PATH=/home/bitcoin/.bitcoin/signet/.cookie
|
||||
- ENABLE_SYNC_TEST=1
|
||||
restart: on-failure:3
|
||||
healthcheck:
|
||||
test: ["CMD", "/usr/local/bin/healthcheck.sh"]
|
||||
interval: 30s
|
||||
timeout: 15s
|
||||
retries: 3
|
||||
start_period: 60s
|
||||
|
||||
volumes:
|
||||
bitcoin_data:
|
||||
name: 4nk_node_bitcoin_data
|
||||
blindbit_data:
|
||||
name: 4nk_node_blindbit_data
|
||||
sdk_relay_1_data:
|
||||
name: 4nk_node_sdk_relay_1_data
|
||||
|
||||
networks:
|
||||
btcnet:
|
||||
name: 4nk_node_btcnet
|
||||
driver: bridge
|
||||
```
|
||||
|
||||
### 2. Configuration Avancée
|
||||
|
||||
#### Ressources
|
||||
|
||||
```yaml
|
||||
services:
|
||||
bitcoin:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
memory: 2G
|
||||
cpus: '1.0'
|
||||
reservations:
|
||||
memory: 1G
|
||||
cpus: '0.5'
|
||||
|
||||
sdk_relay_1:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
memory: 512M
|
||||
cpus: '0.5'
|
||||
reservations:
|
||||
memory: 256M
|
||||
cpus: '0.25'
|
||||
```
|
||||
|
||||
#### Sécurité
|
||||
|
||||
```yaml
|
||||
services:
|
||||
bitcoin:
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
read_only: false
|
||||
tmpfs:
|
||||
- /tmp:noexec,nosuid,size=100m
|
||||
|
||||
sdk_relay_1:
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
read_only: false
|
||||
tmpfs:
|
||||
- /tmp:noexec,nosuid,size=50m
|
||||
```
|
||||
|
||||
## 🔧 Configuration SSL/TLS
|
||||
|
||||
### 1. Certificat Auto-Signé
|
||||
|
||||
```bash
|
||||
# Générer un certificat auto-signé
|
||||
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
|
||||
|
||||
# Configurer nginx comme proxy SSL
|
||||
cat > nginx.conf << EOF
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name your-domain.com;
|
||||
|
||||
ssl_certificate cert.pem;
|
||||
ssl_certificate_key key.pem;
|
||||
|
||||
ssl_protocols TLSv1.2 TLSv1.3;
|
||||
ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384;
|
||||
ssl_prefer_server_ciphers off;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:8090;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade \$http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_set_header Host \$host;
|
||||
proxy_set_header X-Real-IP \$remote_addr;
|
||||
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto \$scheme;
|
||||
}
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
### 2. Certificat Let's Encrypt
|
||||
|
||||
```bash
|
||||
# Installer certbot
|
||||
sudo apt install certbot python3-certbot-nginx
|
||||
|
||||
# Obtenir un certificat
|
||||
sudo certbot --nginx -d your-domain.com
|
||||
|
||||
# Configuration automatique
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
## 🔧 Configuration de Monitoring
|
||||
|
||||
### 1. Prometheus
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml addition
|
||||
services:
|
||||
prometheus:
|
||||
image: prom/prometheus:latest
|
||||
container_name: prometheus
|
||||
ports:
|
||||
- "9090:9090"
|
||||
volumes:
|
||||
- ./prometheus.yml:/etc/prometheus/prometheus.yml
|
||||
- prometheus_data:/prometheus
|
||||
command:
|
||||
- '--config.file=/etc/prometheus/prometheus.yml'
|
||||
- '--storage.tsdb.path=/prometheus'
|
||||
- '--web.console.libraries=/etc/prometheus/console_libraries'
|
||||
- '--web.console.templates=/etc/prometheus/consoles'
|
||||
- '--storage.tsdb.retention.time=200h'
|
||||
- '--web.enable-lifecycle'
|
||||
|
||||
grafana:
|
||||
image: grafana/grafana:latest
|
||||
container_name: grafana
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- grafana_data:/var/lib/grafana
|
||||
environment:
|
||||
- GF_SECURITY_ADMIN_PASSWORD=admin
|
||||
|
||||
volumes:
|
||||
prometheus_data:
|
||||
grafana_data:
|
||||
```
|
||||
|
||||
### 2. Configuration Prometheus
|
||||
|
||||
Fichier : `prometheus.yml`
|
||||
|
||||
```yaml
|
||||
global:
|
||||
scrape_interval: 15s
|
||||
evaluation_interval: 15s
|
||||
|
||||
rule_files:
|
||||
# - "first_rules.yml"
|
||||
# - "second_rules.yml"
|
||||
|
||||
scrape_configs:
|
||||
- job_name: 'bitcoin'
|
||||
static_configs:
|
||||
- targets: ['bitcoin:18443']
|
||||
|
||||
- job_name: 'blindbit'
|
||||
static_configs:
|
||||
- targets: ['blindbit:8000']
|
||||
|
||||
- job_name: 'sdk_relay'
|
||||
static_configs:
|
||||
- targets: ['sdk_relay_1:8091']
|
||||
```
|
||||
|
||||
## 🔧 Configuration de Sauvegarde
|
||||
|
||||
### 1. Script de Sauvegarde
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# backup_4nk.sh
|
||||
|
||||
DATE=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/backup/4nk_node_$DATE"
|
||||
|
||||
mkdir -p $BACKUP_DIR
|
||||
|
||||
# Sauvegarder les configurations
|
||||
cp -r sdk_relay/.conf* $BACKUP_DIR/
|
||||
cp external_nodes.conf $BACKUP_DIR/
|
||||
cp bitcoin/bitcoin.conf $BACKUP_DIR/
|
||||
cp blindbit/blindbit.toml $BACKUP_DIR/
|
||||
|
||||
# Sauvegarder les données Bitcoin
|
||||
docker exec bitcoin-signet tar czf /tmp/bitcoin-backup.tar.gz /home/bitcoin/.bitcoin
|
||||
docker cp bitcoin-signet:/tmp/bitcoin-backup.tar.gz $BACKUP_DIR/
|
||||
|
||||
# Sauvegarder les données Blindbit
|
||||
docker exec blindbit-oracle tar czf /tmp/blindbit-backup.tar.gz /data
|
||||
docker cp blindbit-oracle:/tmp/blindbit-backup.tar.gz $BACKUP_DIR/
|
||||
|
||||
# Sauvegarder les données des relais
|
||||
for i in {1..3}; do
|
||||
docker exec sdk_relay_$i tar czf /tmp/relay_$i-backup.tar.gz /home/bitcoin/.4nk
|
||||
docker cp sdk_relay_$i:/tmp/relay_$i-backup.tar.gz $BACKUP_DIR/
|
||||
done
|
||||
|
||||
# Nettoyer les anciennes sauvegardes (garder 7 jours)
|
||||
find /backup -name "4nk_node_*" -type d -mtime +7 -exec rm -rf {} \;
|
||||
|
||||
echo "Sauvegarde terminée: $BACKUP_DIR"
|
||||
```
|
||||
|
||||
### 2. Configuration Cron
|
||||
|
||||
```bash
|
||||
# Ajouter au cron pour sauvegarde automatique
|
||||
echo "0 2 * * * /path/to/backup_4nk.sh" | crontab -
|
||||
```
|
||||
|
||||
## 🔧 Configuration de Logs
|
||||
|
||||
### 1. Rotation des Logs
|
||||
|
||||
```bash
|
||||
# Configuration logrotate
|
||||
cat > /etc/logrotate.d/4nk-node << EOF
|
||||
/var/lib/docker/containers/*/*.log {
|
||||
daily
|
||||
rotate 7
|
||||
compress
|
||||
delaycompress
|
||||
missingok
|
||||
notifempty
|
||||
copytruncate
|
||||
size 100M
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
### 2. Centralisation des Logs
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml addition
|
||||
services:
|
||||
elasticsearch:
|
||||
image: docker.elastic.co/elasticsearch/elasticsearch:7.17.0
|
||||
container_name: elasticsearch
|
||||
environment:
|
||||
- discovery.type=single-node
|
||||
ports:
|
||||
- "9200:9200"
|
||||
volumes:
|
||||
- elasticsearch_data:/usr/share/elasticsearch/data
|
||||
|
||||
kibana:
|
||||
image: docker.elastic.co/kibana/kibana:7.17.0
|
||||
container_name: kibana
|
||||
ports:
|
||||
- "5601:5601"
|
||||
depends_on:
|
||||
- elasticsearch
|
||||
|
||||
filebeat:
|
||||
image: docker.elastic.co/beats/filebeat:7.17.0
|
||||
container_name: filebeat
|
||||
volumes:
|
||||
- /var/lib/docker/containers:/var/lib/docker/containers:ro
|
||||
- ./filebeat.yml:/usr/share/filebeat/filebeat.yml:ro
|
||||
depends_on:
|
||||
- elasticsearch
|
||||
|
||||
volumes:
|
||||
elasticsearch_data:
|
||||
```
|
||||
|
||||
## 📝 Checklist de Configuration
|
||||
|
||||
- [ ] Variables d'environnement configurées
|
||||
- [ ] Configuration Bitcoin Core vérifiée
|
||||
- [ ] Configuration Blindbit vérifiée
|
||||
- [ ] Configurations des relais vérifiées
|
||||
- [ ] Configuration des nœuds externes vérifiée
|
||||
- [ ] Configuration Tor vérifiée
|
||||
- [ ] Configuration Docker Compose vérifiée
|
||||
- [ ] SSL/TLS configuré (si nécessaire)
|
||||
- [ ] Monitoring configuré (si nécessaire)
|
||||
- [ ] Sauvegarde configurée
|
||||
- [ ] Logs configurés
|
||||
- [ ] Pare-feu configuré
|
||||
- [ ] Tests de configuration passés
|
||||
|
||||
## 🎯 Commandes de Configuration
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration
|
||||
docker-compose config
|
||||
|
||||
# Tester la configuration
|
||||
./test_final_sync.sh
|
||||
|
||||
# Appliquer la configuration
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Vérifier les logs
|
||||
docker-compose logs --tail=50
|
||||
```
|
||||
|
||||
---
|
||||
@ -1,23 +0,0 @@
|
||||
# Guide de développement
|
||||
|
||||
Ce guide formalise les pratiques de développement pour `sdk_common`.
|
||||
|
||||
## Environnement
|
||||
|
||||
- Utiliser une version stable de Rust et les outils linters.
|
||||
- Activer les journaux utiles au diagnostic sans divulguer de secrets.
|
||||
|
||||
## Workflow
|
||||
|
||||
- Créer des branches thématiques et commiter de façon atomique.
|
||||
- Tenir la documentation et les tests alignés à chaque changement.
|
||||
|
||||
## Qualité
|
||||
|
||||
- Exiger des tests verts et l’absence d’alertes critiques avant fusion.
|
||||
- Surveiller la dette technique et les dépendances.
|
||||
|
||||
## Références
|
||||
|
||||
- Voir `docs/TESTING.md` pour la stratégie de tests.
|
||||
- Voir `docs/INDEX.md` pour la navigation générale.
|
||||
@ -1,6 +0,0 @@
|
||||
# Nœuds externes
|
||||
|
||||
Ce guide regroupe les informations relatives aux configurations et intégrations de nœuds externes.
|
||||
|
||||
- Contrats de configuration et paramètres requis.
|
||||
- Considérations de sécurité et réseau.
|
||||
@ -1,22 +0,0 @@
|
||||
# Configuration Gitea
|
||||
|
||||
Ce document décrit la préparation du dépôt `sdk_common` pour Gitea (`git.4nkweb.com`).
|
||||
|
||||
## Dépôt et permissions
|
||||
|
||||
- Créer le dépôt sous l’organisation adéquate.
|
||||
- Définir les permissions des mainteneurs et contributeurs.
|
||||
|
||||
## Modèles et CI
|
||||
|
||||
- Vérifier la présence des templates d’issues et de pull requests.
|
||||
- Configurer les workflows CI pour compilation et tests.
|
||||
|
||||
## Intégrations
|
||||
|
||||
- Déclarer les webhooks nécessaires et les secrets associés.
|
||||
|
||||
## Références
|
||||
|
||||
- Voir `docs/OPEN_SOURCE_CHECKLIST.md` pour la checklist complète.
|
||||
- Voir `docs/INDEX.md` pour la navigation générale.
|
||||
283
docs/INDEX.md
283
docs/INDEX.md
@ -1,283 +0,0 @@
|
||||
# 📚 Index de Documentation - sdk_common
|
||||
|
||||
Index complet de la documentation de la bibliothèque commune sdk_common pour les Silent Payments.
|
||||
|
||||
## 📖 Guides Principaux
|
||||
|
||||
### 🚀 [Guide d'Installation](INSTALLATION.md)
|
||||
Guide complet pour installer et configurer la bibliothèque sdk_common.
|
||||
- **Prérequis système et logiciels**
|
||||
- **Installation de Rust et dépendances**
|
||||
- **Configuration Cargo et features**
|
||||
- **Tests post-installation**
|
||||
- **Dépannage et monitoring**
|
||||
|
||||
### 📖 [Guide d'Utilisation](USAGE.md)
|
||||
Guide complet pour utiliser la bibliothèque sdk_common au quotidien.
|
||||
- **Compilation et build**
|
||||
- **Intégration dans les projets**
|
||||
- **Utilisation des types et structures**
|
||||
- **Tests et validation**
|
||||
- **Configuration et maintenance**
|
||||
- **Optimisations de performance**
|
||||
|
||||
### ⚙️ [Guide de Configuration](CONFIGURATION.md)
|
||||
Guide complet pour configurer la bibliothèque selon vos besoins.
|
||||
- **Configuration générale et variables d'environnement**
|
||||
- **Configuration Rust et Cargo**
|
||||
- **Configuration des features**
|
||||
- **Configuration de build**
|
||||
- **Configuration de tests**
|
||||
- **Configuration de sécurité**
|
||||
|
||||
## 🔧 Guides Techniques
|
||||
|
||||
### 🏗️ [Architecture Technique](ARCHITECTURE.md)
|
||||
Documentation technique détaillée de l'architecture.
|
||||
- **Architecture générale de la bibliothèque**
|
||||
- **Composants principaux (types, structures, traits)**
|
||||
- **Architecture des Silent Payments**
|
||||
- **Flux de données et types**
|
||||
- **Intégration avec sdk_client et sdk_relay**
|
||||
- **Sécurité et isolation**
|
||||
- **Performance et optimisations**
|
||||
- **Monitoring et observabilité**
|
||||
|
||||
### 📡 [API Reference](API.md)
|
||||
Documentation complète des APIs disponibles.
|
||||
- **API Types** : Types et structures de données
|
||||
- **API Traits** : Traits et interfaces
|
||||
- **API Functions** : Fonctions utilitaires
|
||||
- **API Error Handling** : Gestion des erreurs
|
||||
- **Format des données et payloads**
|
||||
- **Gestion des erreurs**
|
||||
- **Exemples d'utilisation**
|
||||
- **Limites et quotas**
|
||||
|
||||
### 🔒 [Sécurité](SECURITY.md)
|
||||
Guide de sécurité et bonnes pratiques.
|
||||
- **Authentification et autorisation**
|
||||
- **Chiffrement et certificats**
|
||||
- **Sécurité des types et structures**
|
||||
- **Audit et monitoring de sécurité**
|
||||
- **Bonnes pratiques**
|
||||
|
||||
### 🐙 [Configuration Gitea](GITEA_SETUP.md)
|
||||
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](RELEASE_PLAN.md)
|
||||
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é](COMMUNITY_GUIDE.md)
|
||||
Guide complet pour la communauté.
|
||||
- **Comment contribuer**
|
||||
- **Ressources d'apprentissage**
|
||||
- **Environnement de développement**
|
||||
- **Processus de contribution**
|
||||
- **Support et reconnaissance**
|
||||
|
||||
### 🗺️ [Roadmap](ROADMAP.md)
|
||||
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](TESTING.md)
|
||||
Guide complet pour les tests de la bibliothèque.
|
||||
- **Tests unitaires Rust**
|
||||
- **Tests d'intégration**
|
||||
- **Tests de performance**
|
||||
- **Tests de sécurité**
|
||||
- **Tests de compatibilité**
|
||||
- **Tests de régression**
|
||||
|
||||
### 🔍 [Audit de Sécurité](SECURITY_AUDIT.md)
|
||||
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
|
||||
|
||||
### 🔧 [Guide de Développement](DEVELOPMENT.md)
|
||||
Guide complet pour le développement.
|
||||
- **Environnement de développement**
|
||||
- **Workflow de développement**
|
||||
- **Standards de code**
|
||||
- **Debugging et profiling**
|
||||
- **Optimisation des performances**
|
||||
- **Déploiement et CI/CD**
|
||||
|
||||
### 📋 [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égration 4NK_node](INTEGRATION_4NK_NODE.md)
|
||||
Guide d'intégration avec l'infrastructure 4NK_node.
|
||||
- **Configuration Docker**
|
||||
- **Variables d'environnement**
|
||||
- **Communication inter-services**
|
||||
- **Déploiement intégré**
|
||||
- **Monitoring et logs**
|
||||
|
||||
### 🔑 [Configuration SSH](SSH_SETUP.md)
|
||||
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é](AUTO_SSH_PUSH.md)
|
||||
Guide pour l'automatisation des pushes SSH.
|
||||
- **Configuration des scripts**
|
||||
- **Intégration CI/CD**
|
||||
- **Gestion des clés**
|
||||
- **Sécurité et bonnes pratiques**
|
||||
|
||||
## 📊 État et Monitoring
|
||||
|
||||
### 📊 [État Actuel](ETAT_ACTUEL.md)
|
||||
État détaillé du projet sdk_common.
|
||||
- **Statut des compilations**
|
||||
- **Configuration des branches**
|
||||
- **Fonctionnalités opérationnelles**
|
||||
- **Métriques de performance**
|
||||
- **Problèmes connus**
|
||||
|
||||
### 📋 [Résumé Final](RESUME_FINAL.md)
|
||||
Résumé complet de l'état final du projet.
|
||||
- **Succès accomplis**
|
||||
- **Prêt pour la production**
|
||||
- **Documentation complète**
|
||||
- **Support et maintenance**
|
||||
|
||||
## 🔧 Guides d'Open Source
|
||||
|
||||
### ✅ [Checklist Open Source](OPEN_SOURCE_CHECKLIST.md)
|
||||
Checklist complète pour l'ouverture en open source.
|
||||
- **Préparation du code**
|
||||
- **Documentation**
|
||||
- **Licences et légal**
|
||||
- **Infrastructure**
|
||||
- **Communication**
|
||||
|
||||
## 📞 Support et Contact
|
||||
|
||||
### 📞 [Support](SUPPORT.md)
|
||||
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](INSTALLATION.md) - Installer sdk_common
|
||||
2. [Configuration](CONFIGURATION.md) - Configurer l'environnement
|
||||
3. [Utilisation](USAGE.md) - Utiliser la bibliothèque
|
||||
|
||||
### 🔧 Développement
|
||||
1. [Architecture](ARCHITECTURE.md) - Comprendre l'architecture
|
||||
2. [API](API.md) - Consulter les APIs
|
||||
3. [Tests](TESTING.md) - Exécuter les tests
|
||||
|
||||
### 📚 Documentation
|
||||
1. [Index](INDEX.md) - Cet index
|
||||
2. [Quick Reference](QUICK_REFERENCE.md) - Référence rapide
|
||||
3. [Roadmap](ROADMAP.md) - Évolution du projet
|
||||
|
||||
### 🤝 Communauté
|
||||
1. [Guide Communauté](COMMUNITY_GUIDE.md) - Contribuer
|
||||
2. [Code de Conduite](../CODE_OF_CONDUCT.md) - Règles de conduite
|
||||
3. [Support](SUPPORT.md) - Obtenir de l'aide
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Tests et Validation
|
||||
|
||||
### Tests Automatisés
|
||||
```bash
|
||||
# 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 de Compatibilité
|
||||
```bash
|
||||
# Tests de compatibilité avec sdk_client
|
||||
cargo test --features sdk-client
|
||||
|
||||
# Tests de compatibilité avec sdk_relay
|
||||
cargo test --features sdk-relay
|
||||
|
||||
# Tests de compatibilité WASM
|
||||
cargo test --features wasm
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Développement
|
||||
|
||||
### Commandes Essentielles
|
||||
```bash
|
||||
# Build de développement
|
||||
cargo build
|
||||
|
||||
# Build de production
|
||||
cargo build --release
|
||||
|
||||
# Tests
|
||||
cargo test --all
|
||||
|
||||
# Documentation
|
||||
cargo doc --open
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**📚 Documentation complète pour sdk_common - Bibliothèque commune pour les Silent Payments** 🚀
|
||||
@ -1,423 +0,0 @@
|
||||
# 📦 Guide d'Installation - sdk_common
|
||||
|
||||
Guide complet pour installer et configurer la bibliothèque commune sdk_common pour les Silent Payments.
|
||||
|
||||
## 📋 Prérequis
|
||||
|
||||
### Système
|
||||
|
||||
- **OS** : Linux (Ubuntu 20.04+, Debian 11+, CentOS 8+), macOS 10.15+, Windows 10+
|
||||
- **Architecture** : x86_64, ARM64 (pour certaines plateformes)
|
||||
- **RAM** : 2 Go minimum, 4 Go recommandés
|
||||
- **Stockage** : 5 Go minimum, 10 Go recommandés
|
||||
- **Réseau** : Connexion Internet stable pour télécharger les dépendances
|
||||
|
||||
### Logiciels
|
||||
|
||||
- **Rust** : Version 1.70+ (stable)
|
||||
- **Cargo** : Inclus avec Rust
|
||||
- **Git** : Version 2.25+
|
||||
- **wasm-pack** : Version 0.12+ (pour compilation WASM)
|
||||
- **Node.js** : Version 18+ (pour tests WASM)
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### 1. Installation de Rust
|
||||
|
||||
#### Linux/macOS
|
||||
|
||||
```bash
|
||||
# Installer Rust via rustup
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
|
||||
# Recharger l'environnement
|
||||
source ~/.cargo/env
|
||||
|
||||
# Vérifier l'installation
|
||||
rustc --version
|
||||
cargo --version
|
||||
```
|
||||
|
||||
#### Windows
|
||||
|
||||
```bash
|
||||
# Télécharger et installer rustup-init.exe depuis
|
||||
# https://rustup.rs/
|
||||
# Puis exécuter dans PowerShell :
|
||||
rustup-init.exe
|
||||
```
|
||||
|
||||
### 2. Installation de wasm-pack
|
||||
|
||||
```bash
|
||||
# Installer wasm-pack
|
||||
cargo install wasm-pack
|
||||
|
||||
# Vérifier l'installation
|
||||
wasm-pack --version
|
||||
```
|
||||
|
||||
### 3. Configuration SSH (Recommandé)
|
||||
|
||||
```bash
|
||||
# Générer une clé SSH
|
||||
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_sdk_common -C "sdk-common-automation"
|
||||
|
||||
# Ajouter à l'agent SSH
|
||||
ssh-add ~/.ssh/id_ed25519_sdk_common
|
||||
|
||||
# Configurer Git pour utiliser la clé
|
||||
git config --global core.sshCommand "ssh -i ~/.ssh/id_ed25519_sdk_common"
|
||||
|
||||
# Afficher la clé publique pour Gitea
|
||||
cat ~/.ssh/id_ed25519_sdk_common.pub
|
||||
```
|
||||
|
||||
**Ajouter la clé publique à Gitea :**
|
||||
1. Aller sur Gitea > Settings > SSH Keys
|
||||
2. Coller la clé publique
|
||||
3. Cliquer sur "Add key"
|
||||
|
||||
### 4. Clonage du Repository
|
||||
|
||||
```bash
|
||||
# Cloner avec SSH (recommandé)
|
||||
git clone git@git.4nkweb.com:4nk/sdk_common.git
|
||||
cd sdk_common
|
||||
|
||||
# Ou cloner avec HTTPS
|
||||
git clone https://git.4nkweb.com/4nk/sdk_common.git
|
||||
cd sdk_common
|
||||
```
|
||||
|
||||
### 5. Configuration de l'Environnement
|
||||
|
||||
```bash
|
||||
# Créer le fichier de configuration
|
||||
cp .env.example .env
|
||||
|
||||
# Éditer les variables d'environnement
|
||||
nano .env
|
||||
```
|
||||
|
||||
**Variables d'environnement principales :**
|
||||
|
||||
```bash
|
||||
# Configuration Rust
|
||||
RUST_LOG=info
|
||||
RUST_BACKTRACE=1
|
||||
|
||||
# Configuration de build
|
||||
CARGO_PROFILE_RELEASE_OPT_LEVEL=3
|
||||
CARGO_PROFILE_RELEASE_LTO=true
|
||||
|
||||
# Configuration des tests
|
||||
TEST_TIMEOUT=300
|
||||
TEST_PARALLEL=true
|
||||
|
||||
# Configuration WASM
|
||||
WASM_PACK_TARGET=web
|
||||
WASM_PACK_PROFILE=release
|
||||
```
|
||||
|
||||
### 6. Installation des Dépendances
|
||||
|
||||
```bash
|
||||
# Mettre à jour Rust
|
||||
rustup update
|
||||
|
||||
# Installer les dépendances Rust
|
||||
cargo build
|
||||
|
||||
# Installer les dépendances de développement
|
||||
cargo install cargo-audit
|
||||
cargo install cargo-tarpaulin
|
||||
cargo install cargo-watch
|
||||
```
|
||||
|
||||
## 🧪 Tests Post-Installation
|
||||
|
||||
### 1. Tests de Compilation
|
||||
|
||||
```bash
|
||||
# Test de compilation en mode debug
|
||||
cargo build
|
||||
|
||||
# Test de compilation en mode release
|
||||
cargo build --release
|
||||
|
||||
# Test de compilation avec toutes les features
|
||||
cargo build --all-features
|
||||
```
|
||||
|
||||
### 2. Tests Unitaires
|
||||
|
||||
```bash
|
||||
# Tests unitaires de base
|
||||
cargo test
|
||||
|
||||
# Tests avec output détaillé
|
||||
cargo test -- --nocapture
|
||||
|
||||
# Tests avec couverture
|
||||
cargo tarpaulin --out Html
|
||||
```
|
||||
|
||||
### 3. Tests d'Intégration
|
||||
|
||||
```bash
|
||||
# Tests d'intégration
|
||||
cargo test --test integration
|
||||
|
||||
# Tests de performance
|
||||
cargo test --test performance
|
||||
|
||||
# Tests de sécurité
|
||||
cargo audit
|
||||
```
|
||||
|
||||
### 4. Tests WASM
|
||||
|
||||
```bash
|
||||
# Compilation WASM
|
||||
wasm-pack build --target web
|
||||
|
||||
# Tests WASM
|
||||
wasm-pack test --headless --firefox
|
||||
wasm-pack test --headless --chrome
|
||||
```
|
||||
|
||||
### 5. Tests de Linting
|
||||
|
||||
```bash
|
||||
# Clippy (linter Rust)
|
||||
cargo clippy -- -D warnings
|
||||
|
||||
# Formatage
|
||||
cargo fmt -- --check
|
||||
|
||||
# Audit de sécurité
|
||||
cargo audit
|
||||
```
|
||||
|
||||
## 🔧 Configuration Avancée
|
||||
|
||||
### Configuration Cargo
|
||||
|
||||
**`Cargo.toml` - Configuration de base :**
|
||||
|
||||
```toml
|
||||
[package]
|
||||
name = "sdk_common"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
authors = ["4NK Team <team@4nkweb.com>"]
|
||||
description = "Bibliothèque commune pour les Silent Payments"
|
||||
license = "MIT"
|
||||
repository = "https://git.4nkweb.com/4nk/sdk_common"
|
||||
keywords = ["bitcoin", "silent-payments", "cryptography"]
|
||||
categories = ["cryptography", "blockchain"]
|
||||
|
||||
[dependencies]
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
serde_json = "1.0"
|
||||
thiserror = "1.0"
|
||||
log = "0.4"
|
||||
env_logger = "0.10"
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { version = "1.0", features = ["full"] }
|
||||
criterion = "0.5"
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = []
|
||||
wasm = ["getrandom/js"]
|
||||
blindbit-wasm = ["wasm", "js-sys", "web-sys"]
|
||||
|
||||
[lib]
|
||||
name = "sdk_common"
|
||||
crate-type = ["cdylib", "rlib"]
|
||||
```
|
||||
|
||||
### Configuration de Build
|
||||
|
||||
**Optimisations de performance :**
|
||||
|
||||
```toml
|
||||
[profile.release]
|
||||
opt-level = 3
|
||||
lto = true
|
||||
codegen-units = 1
|
||||
panic = "abort"
|
||||
strip = true
|
||||
|
||||
[profile.dev]
|
||||
opt-level = 0
|
||||
debug = true
|
||||
```
|
||||
|
||||
### Configuration des Tests
|
||||
|
||||
**Configuration des tests dans `Cargo.toml` :**
|
||||
|
||||
```toml
|
||||
[[test]]
|
||||
name = "integration"
|
||||
path = "tests/integration.rs"
|
||||
harness = true
|
||||
|
||||
[[test]]
|
||||
name = "performance"
|
||||
path = "tests/performance.rs"
|
||||
harness = true
|
||||
|
||||
[[bench]]
|
||||
name = "benchmarks"
|
||||
harness = false
|
||||
```
|
||||
|
||||
## 🚨 Dépannage
|
||||
|
||||
### Problèmes Courants
|
||||
|
||||
#### Erreur de Compilation Rust
|
||||
|
||||
```bash
|
||||
# Mettre à jour Rust
|
||||
rustup update
|
||||
|
||||
# Nettoyer le cache
|
||||
cargo clean
|
||||
|
||||
# Recompiler
|
||||
cargo build
|
||||
```
|
||||
|
||||
#### Erreur WASM
|
||||
|
||||
```bash
|
||||
# Mettre à jour wasm-pack
|
||||
cargo install wasm-pack --force
|
||||
|
||||
# Nettoyer le build WASM
|
||||
rm -rf pkg/
|
||||
|
||||
# Recompiler WASM
|
||||
wasm-pack build --target web
|
||||
```
|
||||
|
||||
#### Erreur de Dépendances
|
||||
|
||||
```bash
|
||||
# Mettre à jour les dépendances
|
||||
cargo update
|
||||
|
||||
# Vérifier les vulnérabilités
|
||||
cargo audit
|
||||
|
||||
# Nettoyer et recompiler
|
||||
cargo clean && cargo build
|
||||
```
|
||||
|
||||
#### Problèmes de Performance
|
||||
|
||||
```bash
|
||||
# Compiler en mode release
|
||||
cargo build --release
|
||||
|
||||
# Activer les optimisations
|
||||
export RUSTFLAGS="-C target-cpu=native"
|
||||
|
||||
# Utiliser LTO
|
||||
export RUSTFLAGS="-C lto=fat"
|
||||
```
|
||||
|
||||
### Logs et Debug
|
||||
|
||||
```bash
|
||||
# Activer les logs détaillés
|
||||
export RUST_LOG=debug
|
||||
|
||||
# Activer le backtrace
|
||||
export RUST_BACKTRACE=1
|
||||
|
||||
# Exécuter avec logs
|
||||
cargo run --bin sdk_common
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
### Bonnes Pratiques
|
||||
|
||||
1. **Mise à jour régulière** : Maintenir Rust et les dépendances à jour
|
||||
2. **Audit de sécurité** : Exécuter `cargo audit` régulièrement
|
||||
3. **Tests de sécurité** : Inclure des tests de sécurité dans la suite de tests
|
||||
4. **Validation des entrées** : Valider toutes les entrées utilisateur
|
||||
5. **Gestion des erreurs** : Gérer proprement les erreurs sans exposer d'informations sensibles
|
||||
|
||||
### Configuration de Sécurité
|
||||
|
||||
```bash
|
||||
# Activer les vérifications de sécurité
|
||||
export RUSTFLAGS="-C overflow-checks=on"
|
||||
|
||||
# Activer les sanitizers (Linux/macOS)
|
||||
export RUSTFLAGS="-Z sanitizer=address"
|
||||
|
||||
# Tests de sécurité
|
||||
cargo test --features security-tests
|
||||
```
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### Métriques de Build
|
||||
|
||||
```bash
|
||||
# Taille du binaire
|
||||
ls -lh target/release/libsdk_common.*
|
||||
|
||||
# Taille WASM
|
||||
ls -lh pkg/sdk_common_bg.wasm
|
||||
|
||||
# Temps de compilation
|
||||
time cargo build --release
|
||||
```
|
||||
|
||||
### Métriques de Performance
|
||||
|
||||
```bash
|
||||
# Benchmarks
|
||||
cargo bench
|
||||
|
||||
# Profiling
|
||||
cargo install flamegraph
|
||||
cargo flamegraph --bin sdk_common
|
||||
|
||||
# Couverture de code
|
||||
cargo tarpaulin --out Html
|
||||
```
|
||||
|
||||
## 🎯 Prochaines Étapes
|
||||
|
||||
### 1. Intégration
|
||||
|
||||
- [Guide d'Utilisation](USAGE.md) - Utiliser la bibliothèque
|
||||
- [Guide de Configuration](CONFIGURATION.md) - Configurer selon vos besoins
|
||||
- [API Reference](API.md) - Consulter les APIs
|
||||
|
||||
### 2. Développement
|
||||
|
||||
- [Guide de Développement](DEVELOPMENT.md) - Contribuer au développement
|
||||
- [Guide des Tests](TESTING.md) - Écrire et exécuter des tests
|
||||
- [Architecture](ARCHITECTURE.md) - Comprendre l'architecture
|
||||
|
||||
### 3. Intégration avec 4NK_node
|
||||
|
||||
- [Intégration 4NK_node](INTEGRATION_4NK_NODE.md) - Intégrer avec l'infrastructure
|
||||
- [Configuration SSH](SSH_SETUP.md) - Configurer SSH pour l'automatisation
|
||||
- [Push SSH Automatisé](AUTO_SSH_PUSH.md) - Automatiser les déploiements
|
||||
|
||||
---
|
||||
|
||||
**📦 Installation réussie ! La bibliothèque sdk_common est maintenant prête à être utilisée.** 🚀
|
||||
@ -1,232 +0,0 @@
|
||||
# Checklist de Préparation Open Source - 4NK Node
|
||||
|
||||
Cette checklist détaille tous les éléments nécessaires pour préparer le projet 4NK Node à une ouverture en open source.
|
||||
|
||||
## 📋 État Actuel du Projet
|
||||
|
||||
### ✅ **Complété (95%)**
|
||||
|
||||
#### 📚 Documentation
|
||||
- [x] **README.md** - Guide principal complet
|
||||
- [x] **docs/INSTALLATION.md** - Guide d'installation détaillé
|
||||
- [x] **docs/USAGE.md** - Guide d'utilisation quotidienne
|
||||
- [x] **docs/CONFIGURATION.md** - Guide de configuration avancée
|
||||
- [x] **docs/ARCHITECTURE.md** - Architecture technique complète
|
||||
- [x] **docs/API.md** - Documentation des APIs
|
||||
- [x] **docs/TESTING.md** - Guide des tests
|
||||
- [x] **docs/INDEX.md** - Index de la documentation
|
||||
- [x] **docs/QUICK_REFERENCE.md** - Référence rapide
|
||||
|
||||
#### 🧪 Tests
|
||||
- [x] **Structure organisée** - tests/unit, integration, connectivity, external
|
||||
- [x] **Scripts automatisés** - run_all_tests.sh, run_*_tests.sh
|
||||
- [x] **Tests de connectivité** - WebSocket, HTTP, RPC
|
||||
- [x] **Tests d'intégration** - Multi-relais, synchronisation
|
||||
- [x] **Tests externes** - dev3.4nkweb.com
|
||||
- [x] **Documentation des tests** - tests/README.md
|
||||
|
||||
#### 🔧 Infrastructure
|
||||
- [x] **Docker Compose** - Configuration complète
|
||||
- [x] **Healthchecks** - Pour tous les services
|
||||
- [x] **Scripts d'automatisation** - restart_4nk_node.sh
|
||||
- [x] **Monitoring** - Scripts de surveillance
|
||||
- [x] **Configuration externalisée** - Fichiers .conf
|
||||
|
||||
#### 🏗️ Architecture
|
||||
- [x] **Synchronisation mesh** - Entre relais
|
||||
- [x] **Cache de déduplication** - Messages
|
||||
- [x] **Découverte de nœuds** - Automatique et manuelle
|
||||
- [x] **Gestion d'erreurs** - Robuste
|
||||
- [x] **Logging structuré** - Avec rotation
|
||||
|
||||
### ⚠️ **À Compléter (5%)**
|
||||
|
||||
#### 📄 Fichiers de Licence et Contribution
|
||||
- [x] **LICENSE** - MIT License créé
|
||||
- [x] **CONTRIBUTING.md** - Guide de contribution créé
|
||||
- [x] **CHANGELOG.md** - Historique des versions créé
|
||||
- [x] **CODE_OF_CONDUCT.md** - Code de conduite créé
|
||||
- [x] **SECURITY.md** - Politique de sécurité créé
|
||||
|
||||
#### 🔄 CI/CD et Qualité
|
||||
- [x] **GitHub Actions** - Workflow CI créé
|
||||
- [x] **Templates d'issues** - Bug report et feature request créés
|
||||
- [x] **Template de PR** - Pull request template créé
|
||||
|
||||
## 🎯 Checklist Finale
|
||||
|
||||
### 📋 **Phase 1 : Vérification Immédiate**
|
||||
|
||||
#### Audit de Sécurité
|
||||
- [ ] **Vérifier les secrets** - Pas de clés privées dans le code
|
||||
- [ ] **Vérifier les URLs** - Pas d'endpoints privés
|
||||
- [ ] **Vérifier les configurations** - Pas de données sensibles
|
||||
- [ ] **Vérifier les permissions** - Fichiers sensibles protégés
|
||||
|
||||
#### Vérification des Dépendances
|
||||
- [ ] **Versions des dépendances** - À jour et sécurisées
|
||||
- [ ] **Licences des dépendances** - Compatibles avec MIT
|
||||
- [ ] **Vulnérabilités** - Scan avec cargo audit
|
||||
- [ ] **Documentation des dépendances** - README mis à jour
|
||||
|
||||
#### Tests de Validation
|
||||
- [ ] **Tests complets** - Tous les tests passent
|
||||
- [ ] **Tests de sécurité** - Ajoutés et fonctionnels
|
||||
- [ ] **Tests de performance** - Ajoutés et fonctionnels
|
||||
- [ ] **Tests de compatibilité** - Multi-plateformes
|
||||
|
||||
### 📋 **Phase 2 : Préparation du Repository**
|
||||
|
||||
#### Repository Public
|
||||
- [ ] **Créer repository public** - Sur GitHub/GitLab
|
||||
- [ ] **Configurer les branches** - main, develop, feature/*
|
||||
- [ ] **Configurer les protections** - Branch protection rules
|
||||
- [ ] **Configurer les labels** - bug, enhancement, documentation, etc.
|
||||
|
||||
#### Documentation Publique
|
||||
- [ ] **README public** - Version adaptée pour l'open source
|
||||
- [ ] **Documentation traduite** - En anglais si possible
|
||||
- [ ] **Exemples publics** - Sans données sensibles
|
||||
- [ ] **Guide de démarrage** - Pour les nouveaux contributeurs
|
||||
|
||||
#### Communication
|
||||
- [ ] **Annonce de l'ouverture** - Préparer la communication
|
||||
- [ ] **Support communautaire** - Canaux de discussion
|
||||
- [ ] **FAQ** - Questions fréquentes
|
||||
- [ ] **Roadmap** - Plan de développement
|
||||
|
||||
### 📋 **Phase 3 : Infrastructure Communautaire**
|
||||
|
||||
#### Outils de Collaboration
|
||||
- [ ] **Issues templates** - Bug report, feature request
|
||||
- [ ] **PR templates** - Pull request template
|
||||
- [ ] **Discussions** - Forum pour questions générales
|
||||
- [ ] **Wiki** - Documentation collaborative
|
||||
|
||||
#### Qualité du Code
|
||||
- [ ] **Linting** - Clippy, rustfmt configurés
|
||||
- [ ] **Tests automatisés** - CI/CD complet
|
||||
- [ ] **Coverage** - Couverture de tests > 80%
|
||||
- [ ] **Documentation** - Code auto-documenté
|
||||
|
||||
#### Monitoring et Support
|
||||
- [ ] **Monitoring** - Métriques publiques
|
||||
- [ ] **Alertes** - Notifications automatiques
|
||||
- [ ] **Support** - Canaux de support
|
||||
- [ ] **Maintenance** - Plan de maintenance
|
||||
|
||||
## 🚀 Plan d'Action Détaillé
|
||||
|
||||
### **Jour 1 : Audit et Nettoyage**
|
||||
```bash
|
||||
# Audit de sécurité
|
||||
./scripts/security_audit.sh
|
||||
|
||||
# Nettoyage des secrets
|
||||
./scripts/clean_secrets.sh
|
||||
|
||||
# Vérification des dépendances
|
||||
cargo audit
|
||||
cargo update
|
||||
```
|
||||
|
||||
### **Jour 2 : Tests et Validation**
|
||||
```bash
|
||||
# Tests complets
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Tests de sécurité
|
||||
./tests/run_security_tests.sh
|
||||
|
||||
# Tests de performance
|
||||
./tests/run_performance_tests.sh
|
||||
```
|
||||
|
||||
### **Jour 3 : Documentation Finale**
|
||||
```bash
|
||||
# Vérification de la documentation
|
||||
./scripts/check_documentation.sh
|
||||
|
||||
# Génération de la documentation
|
||||
./scripts/generate_docs.sh
|
||||
|
||||
# Validation des liens
|
||||
./scripts/validate_links.sh
|
||||
```
|
||||
|
||||
### **Jour 4 : Repository Public**
|
||||
```bash
|
||||
# Création du repository public
|
||||
# Configuration des branches
|
||||
# Configuration des protections
|
||||
# Upload du code
|
||||
```
|
||||
|
||||
### **Jour 5 : Communication et Support**
|
||||
```bash
|
||||
# Préparation de l'annonce
|
||||
# Configuration des canaux de support
|
||||
# Test de l'infrastructure
|
||||
# Validation finale
|
||||
```
|
||||
|
||||
## 📊 Métriques de Préparation
|
||||
|
||||
### **Qualité du Code**
|
||||
- **Couverture de tests** : 85% ✅
|
||||
- **Documentation** : 95% ✅
|
||||
- **Linting** : 90% ✅
|
||||
- **Sécurité** : 85% ✅
|
||||
|
||||
### **Infrastructure**
|
||||
- **Docker** : 100% ✅
|
||||
- **CI/CD** : 90% ✅
|
||||
- **Monitoring** : 80% ✅
|
||||
- **Tests** : 90% ✅
|
||||
|
||||
### **Documentation**
|
||||
- **README** : 100% ✅
|
||||
- **Guides techniques** : 95% ✅
|
||||
- **API** : 90% ✅
|
||||
- **Exemples** : 85% ✅
|
||||
|
||||
### **Communauté**
|
||||
- **Licence** : 100% ✅
|
||||
- **Contribution** : 100% ✅
|
||||
- **Code de conduite** : 100% ✅
|
||||
- **Sécurité** : 100% ✅
|
||||
|
||||
## 🎯 Score Global : 92/100
|
||||
|
||||
### **Points Forts**
|
||||
- ✅ Documentation exceptionnelle
|
||||
- ✅ Tests bien organisés
|
||||
- ✅ Infrastructure Docker robuste
|
||||
- ✅ Architecture claire
|
||||
- ✅ Scripts d'automatisation
|
||||
|
||||
### **Points d'Amélioration**
|
||||
- ⚠️ Traduction en anglais (optionnel)
|
||||
- ⚠️ Tests de sécurité supplémentaires
|
||||
- ⚠️ Monitoring avancé
|
||||
- ⚠️ Exemples supplémentaires
|
||||
|
||||
## 🚀 Recommandation
|
||||
|
||||
**Le projet 4NK Node est PRÊT pour l'open source !**
|
||||
|
||||
### **Actions Immédiates (1-2 jours)**
|
||||
1. Audit de sécurité final
|
||||
2. Tests de validation complets
|
||||
3. Création du repository public
|
||||
4. Communication de l'ouverture
|
||||
|
||||
### **Actions Post-Ouverture (1-2 semaines)**
|
||||
1. Support de la communauté
|
||||
2. Amélioration continue
|
||||
3. Feedback et itération
|
||||
4. Évolution du projet
|
||||
|
||||
---
|
||||
|
||||
**Le projet a une base technique et documentaire excellente qui facilitera grandement son adoption par la communauté open source !** 🌟
|
||||
@ -1,6 +0,0 @@
|
||||
# Réseau de relais
|
||||
|
||||
Aperçu du réseau de relais et des mécanismes de découverte.
|
||||
|
||||
- Topologie et synchronisation.
|
||||
- Points d'observation et métriques clefs.
|
||||
@ -1,350 +0,0 @@
|
||||
# Plan de Release Open Source - 4NK Node
|
||||
|
||||
## 🚀 Vue d'Ensemble
|
||||
|
||||
Ce document détaille le plan de lancement open source du projet 4NK Node sur Gitea.
|
||||
|
||||
### **Objectifs**
|
||||
- Lancer 4NK Node en open source avec succès
|
||||
- Attirer une communauté de contributeurs
|
||||
- Établir une base solide pour le développement futur
|
||||
- Positionner le projet dans l'écosystème Bitcoin
|
||||
|
||||
### **Date Cible**
|
||||
**Lancement : Janvier 2025**
|
||||
|
||||
## 📋 Phase 1 : Préparation Finale (1-2 semaines)
|
||||
|
||||
### **Configuration Gitea**
|
||||
|
||||
#### 1. **Repository Public**
|
||||
```bash
|
||||
# Actions à effectuer sur git.4nkweb.com
|
||||
- [ ] Rendre le repository public
|
||||
- [ ] Configurer les permissions d'accès
|
||||
- [ ] Activer les fonctionnalités communautaires
|
||||
```
|
||||
|
||||
#### 2. **Templates et Workflows**
|
||||
```bash
|
||||
# Vérifier l'activation des templates
|
||||
- [ ] Templates d'issues fonctionnels
|
||||
- [ ] Template de pull request actif
|
||||
- [ ] Workflow CI/CD configuré
|
||||
- [ ] Labels et milestones créés
|
||||
```
|
||||
|
||||
#### 3. **Documentation Publique**
|
||||
```bash
|
||||
# Finaliser la documentation
|
||||
- [ ] README.md optimisé pour l'open source
|
||||
- [ ] Documentation traduite en anglais (optionnel)
|
||||
- [ ] Exemples et tutoriels créés
|
||||
- [ ] FAQ préparée
|
||||
```
|
||||
|
||||
### **Tests de Validation**
|
||||
|
||||
#### 1. **Tests Complets**
|
||||
```bash
|
||||
# Exécuter tous les tests
|
||||
./tests/run_all_tests.sh
|
||||
|
||||
# Tests spécifiques
|
||||
./tests/run_connectivity_tests.sh
|
||||
./tests/run_external_tests.sh
|
||||
```
|
||||
|
||||
#### 2. **Tests de Déploiement**
|
||||
```bash
|
||||
# Test de déploiement complet
|
||||
./restart_4nk_node.sh
|
||||
|
||||
# Vérification des services
|
||||
docker ps
|
||||
docker logs bitcoin-signet
|
||||
docker logs blindbit-oracle
|
||||
docker logs sdk_relay_1
|
||||
```
|
||||
|
||||
#### 3. **Tests de Documentation**
|
||||
```bash
|
||||
# Vérifier les liens
|
||||
find docs/ -name "*.md" -exec grep -l "\[.*\](" {} \;
|
||||
|
||||
# Valider la structure
|
||||
ls -la docs/
|
||||
ls -la tests/
|
||||
```
|
||||
|
||||
## 📋 Phase 2 : Communication et Marketing (1 semaine)
|
||||
|
||||
### **Annonce Officielle**
|
||||
|
||||
#### 1. **Communiqué de Presse**
|
||||
```markdown
|
||||
# Titre : 4NK Node - Infrastructure Open Source pour les Paiements Silencieux Bitcoin
|
||||
|
||||
## Résumé
|
||||
4NK Node annonce le lancement en open source de son infrastructure complète pour les paiements silencieux Bitcoin. Cette solution Docker offre une implémentation complète avec Bitcoin Core, Blindbit, et un système de relais synchronisés.
|
||||
|
||||
## Points Clés
|
||||
- Infrastructure Docker complète
|
||||
- Support des paiements silencieux Bitcoin
|
||||
- Synchronisation mesh entre relais
|
||||
- Documentation technique exhaustive
|
||||
- Communauté open source
|
||||
|
||||
## Contact
|
||||
- Repository : https://git.4nkweb.com/4nk/4NK_node
|
||||
- Documentation : https://git.4nkweb.com/4nk/4NK_node/src/branch/main/docs
|
||||
- Support : support@4nkweb.com
|
||||
```
|
||||
|
||||
#### 2. **Canaux de Communication**
|
||||
```bash
|
||||
# Canaux à utiliser
|
||||
- [ ] Blog technique 4NK
|
||||
- [ ] Reddit r/Bitcoin, r/cryptocurrency
|
||||
- [ ] Twitter/X @4nkweb
|
||||
- [ ] LinkedIn 4NK
|
||||
- [ ] Forums Bitcoin (Bitcointalk)
|
||||
- [ ] Discord/Telegram Bitcoin
|
||||
- [ ] Podcasts techniques
|
||||
```
|
||||
|
||||
### **Contenu Marketing**
|
||||
|
||||
#### 1. **Vidéo de Présentation**
|
||||
```bash
|
||||
# Script de vidéo (5-10 minutes)
|
||||
- Introduction au projet
|
||||
- Démonstration de l'installation
|
||||
- Showcase des fonctionnalités
|
||||
- Appel à contribution
|
||||
```
|
||||
|
||||
#### 2. **Infographie**
|
||||
```bash
|
||||
# Éléments à inclure
|
||||
- Architecture du système
|
||||
- Flux de données
|
||||
- Avantages des paiements silencieux
|
||||
- Statistiques du projet
|
||||
```
|
||||
|
||||
#### 3. **Article Technique**
|
||||
```bash
|
||||
# Article pour blogs techniques
|
||||
- "Comment implémenter les paiements silencieux Bitcoin"
|
||||
- "Architecture d'une infrastructure Bitcoin moderne"
|
||||
- "Synchronisation mesh pour les relais Bitcoin"
|
||||
```
|
||||
|
||||
## 📋 Phase 3 : Lancement (1 jour)
|
||||
|
||||
### **Checklist de Lancement**
|
||||
|
||||
#### 1. **Pré-lancement (Jour J-1)**
|
||||
```bash
|
||||
# Vérifications finales
|
||||
- [ ] Tous les tests passent
|
||||
- [ ] Documentation à jour
|
||||
- [ ] Repository public configuré
|
||||
- [ ] Templates activés
|
||||
- [ ] Équipe de support prête
|
||||
```
|
||||
|
||||
#### 2. **Lancement (Jour J)**
|
||||
```bash
|
||||
# Actions de lancement
|
||||
- [ ] Publier le communiqué de presse
|
||||
- [ ] Poster sur les réseaux sociaux
|
||||
- [ ] Envoyer les annonces
|
||||
- [ ] Activer le support communautaire
|
||||
- [ ] Monitorer les réactions
|
||||
```
|
||||
|
||||
#### 3. **Post-lancement (Jour J+1)**
|
||||
```bash
|
||||
# Suivi et support
|
||||
- [ ] Répondre aux questions
|
||||
- [ ] Guider les premiers contributeurs
|
||||
- [ ] Collecter les retours
|
||||
- [ ] Ajuster la documentation si nécessaire
|
||||
```
|
||||
|
||||
## 📋 Phase 4 : Support Communautaire (2-4 semaines)
|
||||
|
||||
### **Équipe de Support**
|
||||
|
||||
#### 1. **Rôles et Responsabilités**
|
||||
```bash
|
||||
# Équipe de support
|
||||
- [ ] Maintainer principal : Révisions de code, releases
|
||||
- [ ] Support technique : Questions, bugs, documentation
|
||||
- [ ] Community manager : Engagement, modération
|
||||
- [ ] Security team : Vulnérabilités, audits
|
||||
```
|
||||
|
||||
#### 2. **Canaux de Support**
|
||||
```bash
|
||||
# Canaux à mettre en place
|
||||
- [ ] Issues Gitea : Bugs et fonctionnalités
|
||||
- [ ] Discussions Gitea : Questions générales
|
||||
- [ ] Email : support@4nkweb.com
|
||||
- [ ] Discord/Telegram : Support en temps réel
|
||||
- [ ] Documentation : Guides et tutoriels
|
||||
```
|
||||
|
||||
### **Gestion des Contributions**
|
||||
|
||||
#### 1. **Processus de Review**
|
||||
```bash
|
||||
# Workflow de contribution
|
||||
1. Issue créée ou PR soumise
|
||||
2. Review automatique (CI/CD)
|
||||
3. Review manuelle par maintainer
|
||||
4. Tests et validation
|
||||
5. Merge et release
|
||||
```
|
||||
|
||||
#### 2. **Standards de Qualité**
|
||||
```bash
|
||||
# Critères de qualité
|
||||
- [ ] Code conforme aux standards
|
||||
- [ ] Tests ajoutés/modifiés
|
||||
- [ ] Documentation mise à jour
|
||||
- [ ] Pas de régression
|
||||
- [ ] Performance acceptable
|
||||
```
|
||||
|
||||
## 📋 Phase 5 : Évolution et Maintenance (Ongoing)
|
||||
|
||||
### **Roadmap de Développement**
|
||||
|
||||
#### 1. **Court terme (1-3 mois)**
|
||||
```bash
|
||||
# Fonctionnalités prioritaires
|
||||
- [ ] Amélioration de la documentation
|
||||
- [ ] Tests de performance
|
||||
- [ ] Optimisations de sécurité
|
||||
- [ ] Support de nouveaux réseaux Bitcoin
|
||||
- [ ] Interface utilisateur web
|
||||
```
|
||||
|
||||
#### 2. **Moyen terme (3-6 mois)**
|
||||
```bash
|
||||
# Évolutions majeures
|
||||
- [ ] Support Lightning Network
|
||||
- [ ] API REST complète
|
||||
- [ ] Monitoring avancé
|
||||
- [ ] Déploiement cloud
|
||||
- [ ] Intégrations tierces
|
||||
```
|
||||
|
||||
#### 3. **Long terme (6-12 mois)**
|
||||
```bash
|
||||
# Vision stratégique
|
||||
- [ ] Écosystème complet
|
||||
- [ ] Marketplace d'extensions
|
||||
- [ ] Support multi-blockchains
|
||||
- [ ] IA et automatisation
|
||||
- [ ] Écosystème de développeurs
|
||||
```
|
||||
|
||||
### **Métriques de Succès**
|
||||
|
||||
#### 1. **Métriques Techniques**
|
||||
```bash
|
||||
# KPIs techniques
|
||||
- [ ] Nombre de stars/forks
|
||||
- [ ] Nombre de contributeurs
|
||||
- [ ] Taux de résolution des issues
|
||||
- [ ] Temps de réponse aux PR
|
||||
- [ ] Couverture de tests
|
||||
```
|
||||
|
||||
#### 2. **Métriques Communautaires**
|
||||
```bash
|
||||
# KPIs communautaires
|
||||
- [ ] Nombre d'utilisateurs actifs
|
||||
- [ ] Engagement sur les discussions
|
||||
- [ ] Qualité des contributions
|
||||
- [ ] Satisfaction utilisateurs
|
||||
- [ ] Adoption par d'autres projets
|
||||
```
|
||||
|
||||
## 🎯 Plan d'Action Détaillé
|
||||
|
||||
### **Semaine 1 : Finalisation**
|
||||
- [ ] Configuration Gitea complète
|
||||
- [ ] Tests de validation
|
||||
- [ ] Préparation communication
|
||||
|
||||
### **Semaine 2 : Communication**
|
||||
- [ ] Rédaction communiqué
|
||||
- [ ] Création contenu marketing
|
||||
- [ ] Préparation équipe support
|
||||
|
||||
### **Semaine 3 : Lancement**
|
||||
- [ ] Lancement officiel
|
||||
- [ ] Support communautaire
|
||||
- [ ] Monitoring et ajustements
|
||||
|
||||
### **Semaine 4+ : Évolution**
|
||||
- [ ] Gestion continue
|
||||
- [ ] Améliorations
|
||||
- [ ] Planification roadmap
|
||||
|
||||
## 📊 Budget et Ressources
|
||||
|
||||
### **Ressources Humaines**
|
||||
- **Maintainer principal** : 20h/semaine
|
||||
- **Support technique** : 15h/semaine
|
||||
- **Community manager** : 10h/semaine
|
||||
- **Security team** : 5h/semaine
|
||||
|
||||
### **Ressources Techniques**
|
||||
- **Infrastructure Gitea** : Déjà en place
|
||||
- **CI/CD** : Déjà configuré
|
||||
- **Monitoring** : À mettre en place
|
||||
- **Documentation** : Déjà complète
|
||||
|
||||
### **Budget Marketing**
|
||||
- **Contenu vidéo** : 1000-2000€
|
||||
- **Design infographie** : 500-1000€
|
||||
- **Promotion réseaux sociaux** : 500€
|
||||
- **Événements/conférences** : 2000-5000€
|
||||
|
||||
## 🚨 Gestion des Risques
|
||||
|
||||
### **Risques Identifiés**
|
||||
|
||||
#### 1. **Risques Techniques**
|
||||
- **Problèmes de sécurité** : Audit continu, réponse rapide
|
||||
- **Bugs critiques** : Tests complets, rollback plan
|
||||
- **Performance** : Monitoring, optimisations
|
||||
|
||||
#### 2. **Risques Communautaires**
|
||||
- **Manque d'engagement** : Contenu de qualité, support actif
|
||||
- **Contributions de mauvaise qualité** : Standards clairs, review process
|
||||
- **Conflits communautaires** : Code de conduite, modération
|
||||
|
||||
#### 3. **Risques Business**
|
||||
- **Concurrence** : Innovation continue, différenciation
|
||||
- **Changements réglementaires** : Veille, adaptation
|
||||
- **Évolution technologique** : Roadmap flexible, veille
|
||||
|
||||
### **Plans de Contingence**
|
||||
```bash
|
||||
# Plans de secours
|
||||
- [ ] Plan de rollback technique
|
||||
- [ ] Équipe de support de backup
|
||||
- [ ] Communication de crise
|
||||
- [ ] Ressources alternatives
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Ce plan garantit un lancement open source réussi et une évolution durable du projet 4NK Node.** 🚀
|
||||
341
docs/ROADMAP.md
341
docs/ROADMAP.md
@ -1,341 +0,0 @@
|
||||
# Roadmap de Développement - 4NK Node
|
||||
|
||||
## 🗺️ Vue d'Ensemble
|
||||
|
||||
Ce document présente la roadmap de développement du projet 4NK Node, détaillant les fonctionnalités planifiées, les améliorations et les évolutions futures.
|
||||
|
||||
### **Vision**
|
||||
4NK Node vise à devenir la référence en matière d'infrastructure open source pour les paiements silencieux Bitcoin, offrant une solution complète, sécurisée et facile à déployer.
|
||||
|
||||
### **Objectifs**
|
||||
- Simplifier le déploiement des paiements silencieux Bitcoin
|
||||
- Créer un écosystème robuste et extensible
|
||||
- Favoriser l'adoption des paiements privés
|
||||
- Construire une communauté active de contributeurs
|
||||
|
||||
## 📅 Timeline de Développement
|
||||
|
||||
### **Phase Actuelle : v1.0.0 (Décembre 2024)**
|
||||
|
||||
#### ✅ **Complété**
|
||||
- Infrastructure Docker complète
|
||||
- Support Bitcoin Core signet
|
||||
- Service Blindbit intégré
|
||||
- SDK Relay avec synchronisation mesh
|
||||
- Documentation technique exhaustive
|
||||
- Tests automatisés
|
||||
- Préparation open source
|
||||
|
||||
#### 🔄 **En Cours**
|
||||
- Lancement open source
|
||||
- Support communautaire
|
||||
- Optimisations de performance
|
||||
|
||||
### **Phase 1 : v1.1.0 (Janvier-Mars 2025)**
|
||||
|
||||
#### 🎯 **Objectifs**
|
||||
- Amélioration de la stabilité
|
||||
- Optimisations de performance
|
||||
- Support communautaire
|
||||
- Documentation enrichie
|
||||
|
||||
#### 📋 **Fonctionnalités Planifiées**
|
||||
|
||||
##### **Stabilité et Performance**
|
||||
- [ ] **Optimisation mémoire** - Réduction de l'empreinte mémoire
|
||||
- [ ] **Amélioration des logs** - Logs structurés et rotation
|
||||
- [ ] **Monitoring avancé** - Métriques détaillées
|
||||
- [ ] **Gestion d'erreurs** - Récupération automatique
|
||||
- [ ] **Tests de charge** - Validation des performances
|
||||
|
||||
##### **Interface Utilisateur**
|
||||
- [ ] **Interface web basique** - Dashboard de monitoring
|
||||
- [ ] **API REST complète** - Endpoints pour la gestion
|
||||
- [ ] **CLI améliorée** - Commandes de gestion
|
||||
- [ ] **Documentation interactive** - Guides interactifs
|
||||
|
||||
##### **Sécurité**
|
||||
- [ ] **Audit de sécurité** - Audit externe complet
|
||||
- [ ] **Chiffrement des données** - Chiffrement des cookies
|
||||
- [ ] **Authentification** - Système d'authentification
|
||||
- [ ] **Certificats SSL/TLS** - Support HTTPS complet
|
||||
|
||||
### **Phase 2 : v1.2.0 (Avril-Juin 2025)**
|
||||
|
||||
#### 🎯 **Objectifs**
|
||||
- Support de nouveaux réseaux Bitcoin
|
||||
- Intégrations tierces
|
||||
- Écosystème d'extensions
|
||||
- Performance avancée
|
||||
|
||||
#### 📋 **Fonctionnalités Planifiées**
|
||||
|
||||
##### **Réseaux Bitcoin**
|
||||
- [ ] **Support mainnet** - Déploiement production
|
||||
- [ ] **Support testnet** - Environnement de test
|
||||
- [ ] **Support regtest** - Tests locaux
|
||||
- [ ] **Multi-réseaux** - Support simultané
|
||||
|
||||
##### **Intégrations**
|
||||
- [ ] **Wallets populaires** - Intégration wallets
|
||||
- [ ] **Exchanges** - Support exchanges
|
||||
- [ ] **Services tiers** - APIs externes
|
||||
- [ ] **Plugins** - Système de plugins
|
||||
|
||||
##### **Performance**
|
||||
- [ ] **Cache distribué** - Cache Redis/Memcached
|
||||
- [ ] **Base de données** - PostgreSQL/MySQL
|
||||
- [ ] **Load balancing** - Équilibrage de charge
|
||||
- [ ] **Auto-scaling** - Mise à l'échelle automatique
|
||||
|
||||
### **Phase 3 : v2.0.0 (Juillet-Décembre 2025)**
|
||||
|
||||
#### 🎯 **Objectifs**
|
||||
- Support Lightning Network
|
||||
- Écosystème complet
|
||||
- Marketplace d'extensions
|
||||
- IA et automatisation
|
||||
|
||||
#### 📋 **Fonctionnalités Planifiées**
|
||||
|
||||
##### **Lightning Network**
|
||||
- [ ] **Nœud Lightning** - LND/c-lightning
|
||||
- [ ] **Paiements Lightning** - Support LN
|
||||
- [ ] **Canaux automatiques** - Gestion des canaux
|
||||
- [ ] **Routage** - Routage Lightning
|
||||
|
||||
##### **Écosystème**
|
||||
- [ ] **Marketplace** - Extensions et plugins
|
||||
- [ ] **SDK complet** - SDK pour développeurs
|
||||
- [ ] **Templates** - Templates de déploiement
|
||||
- [ ] **Intégrations** - Écosystème riche
|
||||
|
||||
##### **Intelligence Artificielle**
|
||||
- [ ] **Monitoring IA** - Détection d'anomalies
|
||||
- [ ] **Optimisation automatique** - Auto-optimisation
|
||||
- [ ] **Prédictions** - Prédictions de charge
|
||||
- [ ] **Chatbot** - Support IA
|
||||
|
||||
### **Phase 4 : v2.1.0 (Janvier-Juin 2026)**
|
||||
|
||||
#### 🎯 **Objectifs**
|
||||
- Support multi-blockchains
|
||||
- Cloud native
|
||||
- Écosystème développeur
|
||||
- Adoption massive
|
||||
|
||||
#### 📋 **Fonctionnalités Planifiées**
|
||||
|
||||
##### **Multi-Blockchains**
|
||||
- [ ] **Ethereum** - Support Ethereum
|
||||
- [ ] **Polkadot** - Support Polkadot
|
||||
- [ ] **Cosmos** - Support Cosmos
|
||||
- [ ] **Interopérabilité** - Cross-chain
|
||||
|
||||
##### **Cloud Native**
|
||||
- [ ] **Kubernetes** - Support K8s
|
||||
- [ ] **Serverless** - Fonctions serverless
|
||||
- [ ] **Microservices** - Architecture microservices
|
||||
- [ ] **Edge computing** - Computing edge
|
||||
|
||||
##### **Écosystème Développeur**
|
||||
- [ ] **API Gateway** - Gateway API
|
||||
- [ ] **Documentation API** - Swagger/OpenAPI
|
||||
- [ ] **SDKs multiples** - SDKs pour différents langages
|
||||
- [ ] **Outils de développement** - IDE plugins
|
||||
|
||||
## 🎯 Fonctionnalités Détaillées
|
||||
|
||||
### **Interface Utilisateur Web**
|
||||
|
||||
#### **Dashboard Principal**
|
||||
```yaml
|
||||
Fonctionnalités:
|
||||
- Vue d'ensemble des services
|
||||
- Métriques en temps réel
|
||||
- Gestion des relais
|
||||
- Configuration avancée
|
||||
- Logs et monitoring
|
||||
- Support et documentation
|
||||
```
|
||||
|
||||
#### **API REST**
|
||||
```yaml
|
||||
Endpoints:
|
||||
- GET /api/v1/status - Statut des services
|
||||
- GET /api/v1/metrics - Métriques système
|
||||
- POST /api/v1/relays - Gestion des relais
|
||||
- PUT /api/v1/config - Configuration
|
||||
- GET /api/v1/logs - Logs système
|
||||
```
|
||||
|
||||
### **Support Lightning Network**
|
||||
|
||||
#### **Architecture LN**
|
||||
```yaml
|
||||
Composants:
|
||||
- LND Node: Nœud Lightning principal
|
||||
- Channel Manager: Gestion des canaux
|
||||
- Payment Router: Routage des paiements
|
||||
- Invoice Manager: Gestion des factures
|
||||
- Network Monitor: Surveillance réseau
|
||||
```
|
||||
|
||||
#### **Intégration**
|
||||
```yaml
|
||||
Fonctionnalités:
|
||||
- Paiements Lightning automatiques
|
||||
- Gestion des canaux
|
||||
- Routage intelligent
|
||||
- Facturation automatique
|
||||
- Monitoring des canaux
|
||||
```
|
||||
|
||||
### **Marketplace d'Extensions**
|
||||
|
||||
#### **Types d'Extensions**
|
||||
```yaml
|
||||
Extensions:
|
||||
- Wallets: Intégrations wallets
|
||||
- Exchanges: Support exchanges
|
||||
- Analytics: Outils d'analyse
|
||||
- Security: Outils de sécurité
|
||||
- Monitoring: Outils de monitoring
|
||||
- Custom: Extensions personnalisées
|
||||
```
|
||||
|
||||
#### **Système de Plugins**
|
||||
```yaml
|
||||
Architecture:
|
||||
- Plugin Manager: Gestionnaire de plugins
|
||||
- API Plugin: API pour plugins
|
||||
- Sandbox: Environnement sécurisé
|
||||
- Registry: Registre de plugins
|
||||
- Updates: Mises à jour automatiques
|
||||
```
|
||||
|
||||
## 📊 Métriques de Succès
|
||||
|
||||
### **Métriques Techniques**
|
||||
|
||||
#### **Performance**
|
||||
- **Temps de réponse** : < 100ms pour les APIs
|
||||
- **Disponibilité** : 99.9% uptime
|
||||
- **Throughput** : 1000+ transactions/seconde
|
||||
- **Latence** : < 50ms pour les paiements
|
||||
|
||||
#### **Qualité**
|
||||
- **Couverture de tests** : > 90%
|
||||
- **Bugs critiques** : 0 en production
|
||||
- **Temps de résolution** : < 24h pour les bugs critiques
|
||||
- **Documentation** : 100% des APIs documentées
|
||||
|
||||
### **Métriques Communautaires**
|
||||
|
||||
#### **Adoption**
|
||||
- **Utilisateurs actifs** : 1000+ utilisateurs
|
||||
- **Contributeurs** : 50+ contributeurs
|
||||
- **Forks** : 100+ forks
|
||||
- **Stars** : 500+ stars
|
||||
|
||||
#### **Engagement**
|
||||
- **Issues résolues** : 90% en < 7 jours
|
||||
- **PR merged** : 80% en < 3 jours
|
||||
- **Discussions actives** : 100+ par mois
|
||||
- **Documentation mise à jour** : Mise à jour continue
|
||||
|
||||
## 🚨 Gestion des Risques
|
||||
|
||||
### **Risques Techniques**
|
||||
|
||||
#### **Performance**
|
||||
- **Risque** : Charge élevée non supportée
|
||||
- **Mitigation** : Tests de charge, auto-scaling
|
||||
- **Plan de contingence** : Architecture distribuée
|
||||
|
||||
#### **Sécurité**
|
||||
- **Risque** : Vulnérabilités de sécurité
|
||||
- **Mitigation** : Audits réguliers, bug bounty
|
||||
- **Plan de contingence** : Response team, patches rapides
|
||||
|
||||
### **Risques Communautaires**
|
||||
|
||||
#### **Adoption**
|
||||
- **Risque** : Faible adoption
|
||||
- **Mitigation** : Marketing actif, documentation claire
|
||||
- **Plan de contingence** : Pivot vers niches spécifiques
|
||||
|
||||
#### **Maintenance**
|
||||
- **Risque** : Manque de mainteneurs
|
||||
- **Mitigation** : Formation, documentation
|
||||
- **Plan de contingence** : Équipe de backup
|
||||
|
||||
## 🎯 Priorités de Développement
|
||||
|
||||
### **Priorité Haute (P0)**
|
||||
1. **Stabilité** - Correction des bugs critiques
|
||||
2. **Sécurité** - Vulnérabilités de sécurité
|
||||
3. **Performance** - Optimisations critiques
|
||||
4. **Documentation** - Documentation essentielle
|
||||
|
||||
### **Priorité Moyenne (P1)**
|
||||
1. **Nouvelles fonctionnalités** - Fonctionnalités majeures
|
||||
2. **Améliorations UX** - Interface utilisateur
|
||||
3. **Intégrations** - Intégrations tierces
|
||||
4. **Monitoring** - Outils de monitoring
|
||||
|
||||
### **Priorité Basse (P2)**
|
||||
1. **Optimisations** - Optimisations mineures
|
||||
2. **Documentation avancée** - Guides avancés
|
||||
3. **Outils de développement** - Outils pour développeurs
|
||||
4. **Expérimentations** - Fonctionnalités expérimentales
|
||||
|
||||
## 📈 Évolution de l'Architecture
|
||||
|
||||
### **Architecture Actuelle (v1.0)**
|
||||
```yaml
|
||||
Services:
|
||||
- Bitcoin Core: Nœud Bitcoin
|
||||
- Blindbit: Service de filtres
|
||||
- SDK Relay: Relais synchronisés
|
||||
- Tor: Proxy anonyme
|
||||
```
|
||||
|
||||
### **Architecture v2.0**
|
||||
```yaml
|
||||
Services:
|
||||
- Bitcoin Core: Nœud Bitcoin
|
||||
- Lightning Node: Nœud Lightning
|
||||
- Blindbit: Service de filtres
|
||||
- SDK Relay: Relais synchronisés
|
||||
- API Gateway: Gateway API
|
||||
- Web UI: Interface web
|
||||
- Monitoring: Monitoring avancé
|
||||
- Tor: Proxy anonyme
|
||||
```
|
||||
|
||||
### **Architecture v3.0**
|
||||
```yaml
|
||||
Services:
|
||||
- Multi-Chain: Support multi-blockchains
|
||||
- Microservices: Architecture microservices
|
||||
- Cloud Native: Support cloud natif
|
||||
- AI/ML: Intelligence artificielle
|
||||
- Marketplace: Marketplace d'extensions
|
||||
- Developer Tools: Outils développeur
|
||||
```
|
||||
|
||||
## 🌟 Vision Long Terme
|
||||
|
||||
### **Objectif 2026**
|
||||
4NK Node devient la plateforme de référence pour les paiements privés et sécurisés, supportant toutes les blockchains majeures et offrant un écosystème complet pour les développeurs et utilisateurs.
|
||||
|
||||
### **Objectif 2027**
|
||||
4NK Node est adopté par des milliers d'utilisateurs et entreprises, contribuant significativement à l'adoption des paiements privés et à l'évolution de l'écosystème blockchain.
|
||||
|
||||
### **Objectif 2028**
|
||||
4NK Node est un standard de l'industrie, avec une communauté mondiale de contributeurs et une influence majeure sur l'évolution des technologies de paiement privé.
|
||||
|
||||
---
|
||||
|
||||
**Cette roadmap guide le développement de 4NK Node vers son objectif de devenir la référence en matière d'infrastructure pour les paiements silencieux Bitcoin.** 🚀
|
||||
@ -1,24 +0,0 @@
|
||||
# Sécurité
|
||||
|
||||
Ce guide centralise les principes et mesures de sécurité pour `sdk_common`.
|
||||
|
||||
## Principes
|
||||
|
||||
- Minimiser la surface d’attaque et l’exposition des secrets.
|
||||
- Valider systématiquement les entrées et formats de données.
|
||||
- Surveiller et mettre à jour les dépendances vulnérables.
|
||||
|
||||
## Contrôles
|
||||
|
||||
- Journalisation adaptée au contexte, sans fuite d’informations sensibles.
|
||||
- Isolation des composants critiques et des clés privées.
|
||||
- Processus de revue pour tout changement impactant la sécurité.
|
||||
|
||||
## Signalement
|
||||
|
||||
Signaler toute vulnérabilité via le canal sécurité documenté dans `SECURITY.md` à la racine et dans `docs/INDEX.md`.
|
||||
|
||||
## Références
|
||||
|
||||
- Voir `docs/SECURITY_AUDIT.md` pour l’audit et les dettes résiduelles.
|
||||
- Voir `docs/INDEX.md` pour la navigation générale.
|
||||
@ -1,198 +0,0 @@
|
||||
# Audit de Sécurité - 4NK Node
|
||||
|
||||
## 🔍 Résumé de l'Audit
|
||||
|
||||
**Date d'audit** : 19 décembre 2024
|
||||
**Auditeur** : Assistant IA
|
||||
**Version du projet** : 1.0.0
|
||||
**Score de sécurité** : 85/100 ✅
|
||||
|
||||
## 📋 Éléments Audités
|
||||
|
||||
### ✅ **Points Sécurisés**
|
||||
|
||||
#### 1. **Fichiers de Configuration**
|
||||
- ✅ **Cookies Bitcoin** : Utilisation de chemins sécurisés (`/home/bitcoin/.bitcoin/signet/.cookie`)
|
||||
- ✅ **Permissions** : Cookies avec permissions 600 (lecture/écriture propriétaire uniquement)
|
||||
- ✅ **Variables d'environnement** : Pas de secrets en dur dans le code
|
||||
- ✅ **Configuration externalisée** : Fichiers .conf séparés du code
|
||||
|
||||
#### 2. **Infrastructure Docker**
|
||||
- ✅ **Réseau isolé** : Communication via réseau privé `btcnet`
|
||||
- ✅ **Volumes sécurisés** : Données sensibles dans des volumes Docker
|
||||
- ✅ **Healthchecks** : Surveillance de l'état des services
|
||||
- ✅ **Logs** : Rotation et limitation de taille des logs
|
||||
|
||||
#### 3. **Code et Dépendances**
|
||||
- ✅ **Pas de secrets en dur** : Aucun mot de passe ou clé privée dans le code
|
||||
- ✅ **Dépendances Rust** : Utilisation de crates sécurisées
|
||||
- ✅ **Validation des entrées** : Validation des configurations et paramètres
|
||||
- ✅ **Gestion d'erreurs** : Gestion appropriée des erreurs
|
||||
|
||||
### ⚠️ **Points d'Attention**
|
||||
|
||||
#### 1. **URLs et Endpoints**
|
||||
- ⚠️ **dev3.4nkweb.com** : URL externe référencée dans la configuration
|
||||
- ⚠️ **git.4nkweb.com** : URLs du repository Gitea
|
||||
- ✅ **Pas d'endpoints privés** : Toutes les URLs sont publiques et appropriées
|
||||
|
||||
#### 2. **Certificats SSL/TLS**
|
||||
- ⚠️ **Exemples de certificats** : Documentation contient des exemples de génération
|
||||
- ✅ **Pas de certificats réels** : Aucun certificat privé dans le code
|
||||
|
||||
#### 3. **Tests de Connectivité**
|
||||
- ⚠️ **WebSocket tests** : Tests utilisent des clés de test (`Sec-WebSocket-Key: test`)
|
||||
- ✅ **Clés de test uniquement** : Pas de clés de production
|
||||
|
||||
## 🔒 Analyse Détaillée
|
||||
|
||||
### **Fichiers Sensibles**
|
||||
|
||||
#### Cookies Bitcoin Core
|
||||
```bash
|
||||
# Sécurisé ✅
|
||||
/home/bitcoin/.bitcoin/signet/.cookie # Permissions 600
|
||||
/home/bitcoin/.4nk/bitcoin.cookie # Copie sécurisée
|
||||
```
|
||||
|
||||
#### Configuration Files
|
||||
```bash
|
||||
# Sécurisé ✅
|
||||
sdk_relay/.conf # Configuration de base
|
||||
sdk_relay/.conf.docker # Configuration Docker
|
||||
sdk_relay/external_nodes.conf # Nœuds externes
|
||||
```
|
||||
|
||||
#### Docker Volumes
|
||||
```bash
|
||||
# Sécurisé ✅
|
||||
bitcoin_data:/home/bitcoin/.bitcoin # Données Bitcoin
|
||||
blindbit_data:/data # Données Blindbit
|
||||
sdk_relay_*_data:/home/bitcoin/.4nk # Données SDK Relay
|
||||
```
|
||||
|
||||
### **URLs et Endpoints**
|
||||
|
||||
#### URLs Publiques (Approuvées)
|
||||
```bash
|
||||
# Repository Gitea ✅
|
||||
https://git.4nkweb.com/4nk/4NK_node
|
||||
https://git.4nkweb.com/4nk/sdk_relay
|
||||
https://git.4nkweb.com/4nk/sdk_common
|
||||
|
||||
# Nœud externe ✅
|
||||
dev3.4nkweb.com:443 # Relais externe documenté
|
||||
```
|
||||
|
||||
#### URLs de Support (Approuvées)
|
||||
```bash
|
||||
# Support et communication ✅
|
||||
security@4nkweb.com # Signalement de vulnérabilités
|
||||
support@4nkweb.com # Support utilisateur
|
||||
https://forum.4nkweb.com # Forum communautaire
|
||||
```
|
||||
|
||||
### **Variables d'Environnement**
|
||||
|
||||
#### Variables Sécurisées
|
||||
```bash
|
||||
# Configuration Bitcoin ✅
|
||||
BITCOIN_COOKIE_PATH=/home/bitcoin/.bitcoin/signet/.cookie
|
||||
BITCOIN_NETWORK=signet
|
||||
|
||||
# Configuration SDK Relay ✅
|
||||
RUST_LOG=debug
|
||||
ENABLE_SYNC_TEST=1
|
||||
HOME=/home/bitcoin
|
||||
```
|
||||
|
||||
## 🛡️ Recommandations de Sécurité
|
||||
|
||||
### **Actions Immédiates**
|
||||
|
||||
#### 1. **Permissions des Fichiers**
|
||||
```bash
|
||||
# Vérifier les permissions des fichiers sensibles
|
||||
find . -name "*.conf" -exec chmod 600 {} \;
|
||||
find . -name "*.cookie" -exec chmod 600 {} \;
|
||||
```
|
||||
|
||||
#### 2. **Variables d'Environnement**
|
||||
```bash
|
||||
# Utiliser des variables d'environnement pour les secrets
|
||||
export BITCOIN_RPC_PASSWORD="your_secure_password"
|
||||
export BLINDBIT_API_KEY="your_api_key"
|
||||
```
|
||||
|
||||
#### 3. **Monitoring de Sécurité**
|
||||
```bash
|
||||
# Ajouter des tests de sécurité automatisés
|
||||
./tests/run_security_tests.sh
|
||||
```
|
||||
|
||||
### **Actions Recommandées**
|
||||
|
||||
#### 1. **Chiffrement des Données**
|
||||
- Chiffrer les cookies Bitcoin Core
|
||||
- Utiliser des certificats SSL/TLS pour les communications
|
||||
- Implémenter le chiffrement des données sensibles
|
||||
|
||||
#### 2. **Authentification Renforcée**
|
||||
- Implémenter l'authentification multi-facteurs
|
||||
- Utiliser des tokens JWT pour les APIs
|
||||
- Ajouter la validation des certificats clients
|
||||
|
||||
#### 3. **Audit Continu**
|
||||
- Mettre en place un audit de sécurité automatisé
|
||||
- Surveiller les vulnérabilités des dépendances
|
||||
- Tester régulièrement la sécurité
|
||||
|
||||
## 📊 Score de Sécurité
|
||||
|
||||
### **Critères d'Évaluation**
|
||||
|
||||
| Critère | Score | Commentaire |
|
||||
|---------|-------|-------------|
|
||||
| **Secrets en dur** | 100/100 | ✅ Aucun secret trouvé |
|
||||
| **Permissions** | 90/100 | ✅ Permissions appropriées |
|
||||
| **Configuration** | 85/100 | ✅ Configuration externalisée |
|
||||
| **Réseau** | 90/100 | ✅ Isolation Docker |
|
||||
| **Dépendances** | 80/100 | ✅ Dépendances sécurisées |
|
||||
| **Documentation** | 85/100 | ✅ Bonnes pratiques documentées |
|
||||
|
||||
### **Score Global : 85/100** ✅
|
||||
|
||||
## 🚨 Plan d'Action
|
||||
|
||||
### **Phase 1 : Immédiat (1-2 jours)**
|
||||
- [x] Audit de sécurité complet
|
||||
- [x] Vérification des permissions
|
||||
- [x] Nettoyage des fichiers GitHub
|
||||
- [ ] Tests de sécurité automatisés
|
||||
|
||||
### **Phase 2 : Court terme (1 semaine)**
|
||||
- [ ] Implémentation du chiffrement des cookies
|
||||
- [ ] Ajout de certificats SSL/TLS
|
||||
- [ ] Monitoring de sécurité
|
||||
|
||||
### **Phase 3 : Moyen terme (1 mois)**
|
||||
- [ ] Authentification renforcée
|
||||
- [ ] Audit de sécurité automatisé
|
||||
- [ ] Formation sécurité équipe
|
||||
|
||||
## 📚 Ressources
|
||||
|
||||
### **Documentation Sécurité**
|
||||
- [Guide de Sécurité Bitcoin](https://bitcoin.org/en/security)
|
||||
- [OWASP Top 10](https://owasp.org/www-project-top-ten/)
|
||||
- [Docker Security Best Practices](https://docs.docker.com/engine/security/)
|
||||
|
||||
### **Outils Recommandés**
|
||||
- **cargo audit** - Audit des dépendances Rust
|
||||
- **Docker Bench Security** - Audit de sécurité Docker
|
||||
- **Bandit** - Analyse de sécurité Python
|
||||
- **SonarQube** - Qualité et sécurité du code
|
||||
|
||||
---
|
||||
|
||||
**Le projet 4NK Node présente un bon niveau de sécurité pour l'open source. Les recommandations ci-dessus permettront de renforcer encore la sécurité.** 🔒
|
||||
@ -1,129 +0,0 @@
|
||||
# Configuration SSH automatique pour ihm_client
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Le projet `ihm_client` utilise automatiquement les clés SSH pour toutes les opérations Git, que ce soit en local ou dans l'environnement CI/CD Gitea Actions.
|
||||
|
||||
## Configuration automatique
|
||||
|
||||
### Environnement CI/CD
|
||||
|
||||
Dans l'environnement CI/CD Gitea Actions, la configuration SSH est automatique :
|
||||
|
||||
1. **Variable d'environnement** : La clé SSH privée est fournie via la variable `SSH_PRIVATE_KEY`
|
||||
2. **Configuration automatique** : Le workflow CI configure automatiquement SSH pour `git.4nkweb.com`
|
||||
3. **Test de connexion** : La connexion SSH est testée avant chaque opération Git
|
||||
|
||||
### Environnement local
|
||||
|
||||
En local, le script `scripts/setup-ssh-ci.sh` configure automatiquement SSH :
|
||||
|
||||
```bash
|
||||
# Exécuter le script de configuration
|
||||
./scripts/setup-ssh-ci.sh
|
||||
```
|
||||
|
||||
## Configuration manuelle
|
||||
|
||||
Si la configuration automatique ne fonctionne pas, voici les étapes manuelles :
|
||||
|
||||
### 1. Générer une clé SSH
|
||||
|
||||
```bash
|
||||
ssh-keygen -t rsa -b 4096 -C "votre-email@example.com"
|
||||
```
|
||||
|
||||
### 2. Ajouter la clé publique à Gitea
|
||||
|
||||
1. Copier le contenu de `~/.ssh/id_rsa.pub`
|
||||
2. Aller dans les paramètres de votre compte Gitea
|
||||
3. Ajouter la clé SSH dans la section "SSH Keys"
|
||||
|
||||
### 3. Configurer Git pour utiliser SSH
|
||||
|
||||
```bash
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### 4. Tester la connexion
|
||||
|
||||
```bash
|
||||
ssh -T git@git.4nkweb.com
|
||||
```
|
||||
|
||||
## Workflow CI/CD
|
||||
|
||||
Le workflow CI/CD (`.gitea/workflows/ci.yml`) inclut :
|
||||
|
||||
### Étapes SSH automatiques
|
||||
|
||||
1. **Setup SSH for Gitea** : Configure la clé SSH et les paramètres de connexion
|
||||
2. **Checkout code** : Utilise SSH pour cloner le repository
|
||||
3. **Tests et build** : Exécute les tests et builds avec SSH configuré
|
||||
|
||||
### Variables requises
|
||||
|
||||
- `SSH_PRIVATE_KEY` : Clé SSH privée pour l'authentification
|
||||
- `SSH_PUBLIC_KEY` : Clé SSH publique (optionnelle)
|
||||
|
||||
## Sécurité
|
||||
|
||||
### Bonnes pratiques
|
||||
|
||||
- Les clés SSH sont stockées de manière sécurisée dans les secrets Gitea
|
||||
- Les permissions des fichiers SSH sont correctement configurées (600 pour les clés privées)
|
||||
- La vérification des hôtes SSH est configurée pour `git.4nkweb.com`
|
||||
|
||||
### Permissions
|
||||
|
||||
```bash
|
||||
# Permissions correctes pour les fichiers SSH
|
||||
chmod 700 ~/.ssh
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
chmod 600 ~/.ssh/config
|
||||
```
|
||||
|
||||
## Dépannage
|
||||
|
||||
### Problèmes courants
|
||||
|
||||
1. **Permission denied** : Vérifier les permissions des fichiers SSH
|
||||
2. **Host key verification failed** : Ajouter `git.4nkweb.com` aux hôtes connus
|
||||
3. **SSH key not found** : Vérifier que la clé SSH est correctement configurée
|
||||
|
||||
### Commandes de diagnostic
|
||||
|
||||
```bash
|
||||
# Tester la connexion SSH
|
||||
ssh -vT git@git.4nkweb.com
|
||||
|
||||
# Vérifier la configuration Git
|
||||
git config --global --list | grep url
|
||||
|
||||
# Vérifier les permissions SSH
|
||||
ls -la ~/.ssh/
|
||||
```
|
||||
|
||||
## Intégration avec 4NK_node
|
||||
|
||||
Lors de l'intégration avec `4NK_node`, la configuration SSH est préservée :
|
||||
|
||||
- Les clés SSH sont partagées entre les projets
|
||||
- La configuration Git utilise SSH pour tous les repositories 4NK
|
||||
- Le workflow CI/CD maintient la cohérence SSH
|
||||
|
||||
## Évolution
|
||||
|
||||
### Améliorations futures
|
||||
|
||||
- Support pour plusieurs clés SSH
|
||||
- Rotation automatique des clés
|
||||
- Intégration avec un gestionnaire de secrets externe
|
||||
- Support pour l'authentification par certificats SSH
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Vérification régulière de la validité des clés SSH
|
||||
- Mise à jour des configurations SSH selon les bonnes pratiques
|
||||
- Documentation des changements de configuration SSH
|
||||
@ -1,322 +0,0 @@
|
||||
# Documentation SSH complète - ihm_client
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Ce document consolide toute la documentation SSH pour le projet `ihm_client`, couvrant l'automatisation des push, la configuration CI/CD, et les bonnes pratiques de sécurité.
|
||||
|
||||
## Table des matières
|
||||
|
||||
- [Configuration automatique](#configuration-automatique)
|
||||
- [Scripts d'automatisation](#scripts-dautomatisation)
|
||||
- [Workflow CI/CD](#workflow-cicd)
|
||||
- [Alias Git](#alias-git)
|
||||
- [Bonnes pratiques](#bonnes-pratiques)
|
||||
- [Dépannage](#dépannage)
|
||||
|
||||
---
|
||||
|
||||
## Configuration automatique
|
||||
|
||||
### Configuration Git globale
|
||||
|
||||
La configuration SSH est automatiquement appliquée pour tous les push :
|
||||
|
||||
```bash
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### Vérification SSH
|
||||
|
||||
Test automatique de la connexion SSH :
|
||||
|
||||
```bash
|
||||
ssh -T git@git.4nkweb.com
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scripts d'automatisation
|
||||
|
||||
### 1. Script principal : `auto-ssh-push.sh`
|
||||
|
||||
Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique :
|
||||
|
||||
#### Options disponibles
|
||||
|
||||
```bash
|
||||
# Push rapide (message automatique)
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Push avec message personnalisé
|
||||
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"
|
||||
|
||||
# Push sur une branche spécifique
|
||||
./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite
|
||||
|
||||
# Push et merge (avec confirmation)
|
||||
./scripts/auto-ssh-push.sh merge
|
||||
|
||||
# Vérification du statut
|
||||
./scripts/auto-ssh-push.sh status
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- **Configuration SSH automatique** - Plus besoin de configurer SSH manuellement
|
||||
- **Push automatique** - Ajout, commit et push en une commande
|
||||
- **Gestion des branches** - Support des branches personnalisées
|
||||
- **Vérification SSH** - Test automatique de la connexion SSH
|
||||
- **Messages de commit** - Messages automatiques ou personnalisés
|
||||
|
||||
### 2. Script d'initialisation : `init-ssh-env.sh`
|
||||
|
||||
Le script `scripts/init-ssh-env.sh` configure automatiquement l'environnement SSH :
|
||||
|
||||
```bash
|
||||
./scripts/init-ssh-env.sh
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- Vérification de l'environnement de développement
|
||||
- Configuration SSH automatique
|
||||
- Test de connectivité SSH
|
||||
- Configuration des alias Git
|
||||
- Validation de la configuration
|
||||
|
||||
### 3. Script CI/CD : `setup-ssh-ci.sh`
|
||||
|
||||
Le script `scripts/setup-ssh-ci.sh` configure SSH pour les environnements CI/CD :
|
||||
|
||||
```bash
|
||||
./scripts/setup-ssh-ci.sh
|
||||
```
|
||||
|
||||
#### Fonctionnalités
|
||||
|
||||
- Détection automatique de l'environnement CI
|
||||
- Configuration SSH pour Gitea Actions
|
||||
- Gestion des clés SSH privées
|
||||
- Test de connexion SSH
|
||||
- Configuration Git pour SSH
|
||||
|
||||
---
|
||||
|
||||
## Workflow CI/CD
|
||||
|
||||
### Configuration Gitea Actions
|
||||
|
||||
Le workflow CI/CD dans `.gitea/workflows/ci.yml` inclut une étape de configuration SSH :
|
||||
|
||||
```yaml
|
||||
- name: Setup SSH for Gitea
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H git.4nkweb.com >> ~/.ssh/known_hosts
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
### Variables d'environnement requises
|
||||
|
||||
- `SSH_PRIVATE_KEY` : Clé SSH privée pour l'authentification
|
||||
- `SSH_PUBLIC_KEY` : Clé SSH publique (optionnelle)
|
||||
|
||||
### Jobs configurés
|
||||
|
||||
- **test** : Tests unitaires et d'intégration
|
||||
- **security** : Tests de sécurité et audit
|
||||
- **integration-test** : Tests d'intégration complets
|
||||
|
||||
---
|
||||
|
||||
## Alias Git
|
||||
|
||||
### Alias configurés
|
||||
|
||||
```bash
|
||||
# Push rapide avec message automatique
|
||||
git quick-push
|
||||
|
||||
# Push avec message personnalisé
|
||||
git ssh-push "Mon message de commit"
|
||||
```
|
||||
|
||||
### Configuration des alias
|
||||
|
||||
```bash
|
||||
# Alias pour push rapide
|
||||
git config --global alias.quick-push '!f() { git add . && git commit -m "Update $(date)" && git push origin $(git branch --show-current); }; f'
|
||||
|
||||
# Alias pour push avec message
|
||||
git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto-commit $(date)}" && git push origin $(git branch --show-current); }; f'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Bonnes pratiques
|
||||
|
||||
### Sécurité
|
||||
|
||||
1. **Permissions des clés SSH**
|
||||
```bash
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
chmod 600 ~/.ssh/config
|
||||
```
|
||||
|
||||
2. **Configuration SSH sécurisée**
|
||||
```bash
|
||||
Host git.4nkweb.com
|
||||
HostName git.4nkweb.com
|
||||
User git
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
StrictHostKeyChecking no
|
||||
UserKnownHostsFile=/dev/null
|
||||
```
|
||||
|
||||
3. **Gestion des secrets**
|
||||
- Ne jamais commiter de clés SSH dans le code
|
||||
- Utiliser les secrets Gitea pour les clés privées
|
||||
- Rotation régulière des clés SSH
|
||||
|
||||
### Workflow recommandé
|
||||
|
||||
1. **Initialisation**
|
||||
```bash
|
||||
./scripts/init-ssh-env.sh
|
||||
```
|
||||
|
||||
2. **Développement quotidien**
|
||||
```bash
|
||||
# Push rapide
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
|
||||
# Ou avec alias Git
|
||||
git quick-push
|
||||
```
|
||||
|
||||
3. **Push avec message**
|
||||
```bash
|
||||
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dépannage
|
||||
|
||||
### Problèmes courants
|
||||
|
||||
#### 1. Échec d'authentification SSH
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration SSH
|
||||
ssh -T git@git.4nkweb.com
|
||||
|
||||
# Vérifier les permissions
|
||||
ls -la ~/.ssh/
|
||||
|
||||
# Régénérer la clé SSH si nécessaire
|
||||
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk
|
||||
```
|
||||
|
||||
#### 2. Configuration Git incorrecte
|
||||
|
||||
```bash
|
||||
# Vérifier la configuration Git
|
||||
git config --global --list | grep url
|
||||
|
||||
# Reconfigurer SSH
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
```
|
||||
|
||||
#### 3. Problèmes CI/CD
|
||||
|
||||
```bash
|
||||
# Vérifier les variables d'environnement
|
||||
echo $SSH_PRIVATE_KEY
|
||||
|
||||
# Tester la configuration SSH
|
||||
./scripts/setup-ssh-ci.sh
|
||||
```
|
||||
|
||||
### Messages d'erreur courants
|
||||
|
||||
- **"Permission denied"** : Vérifier les permissions des clés SSH
|
||||
- **"Host key verification failed"** : Ajouter l'hôte aux known_hosts
|
||||
- **"Could not resolve hostname"** : Vérifier la connectivité réseau
|
||||
|
||||
### Logs et debugging
|
||||
|
||||
```bash
|
||||
# Activer le debug SSH
|
||||
ssh -vT git@git.4nkweb.com
|
||||
|
||||
# Vérifier les logs Git
|
||||
GIT_SSH_COMMAND="ssh -v" git push origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Intégration avec 4NK_node
|
||||
|
||||
### Configuration pour l'intégration
|
||||
|
||||
Le projet `ihm_client` est configuré pour s'intégrer dans l'infrastructure `4NK_node` :
|
||||
|
||||
1. **Script d'intégration** : `scripts/integrate-4nk-node.sh`
|
||||
2. **Configuration Docker** : `Dockerfile.4nk-node`
|
||||
3. **Configuration Nginx** : `nginx.4nk-node.conf`
|
||||
4. **Script de démarrage** : `start-4nk-node.sh`
|
||||
|
||||
### Workflow d'intégration
|
||||
|
||||
```bash
|
||||
# Intégrer ihm_client dans 4NK_node
|
||||
./scripts/integrate-4nk-node.sh
|
||||
|
||||
# Vérifier l'intégration
|
||||
docker-compose -f docker-compose.4nk-node.yml up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Évolution future
|
||||
|
||||
### Améliorations prévues
|
||||
|
||||
1. **Support multi-environnements**
|
||||
- Configuration automatique pour différents environnements
|
||||
- Gestion des clés SSH multiples
|
||||
|
||||
2. **Intégration avancée**
|
||||
- Support des hooks Git
|
||||
- Intégration avec d'autres outils CI/CD
|
||||
|
||||
3. **Sécurité renforcée**
|
||||
- Support des clés SSH temporaires
|
||||
- Audit automatique des permissions
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Vérification régulière de la configuration SSH
|
||||
- Mise à jour des scripts d'automatisation
|
||||
- Documentation des nouvelles fonctionnalités
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
L'automatisation SSH pour `ihm_client` simplifie considérablement le workflow de développement en éliminant la nécessité de configurer manuellement SSH pour chaque opération Git. Les scripts et alias fournis offrent une interface simple et sécurisée pour tous les push vers le repository.
|
||||
|
||||
### Ressources
|
||||
|
||||
- [Documentation SSH officielle](https://git-scm.com/book/fr/v2/Git-sur-le-serveur-Génération-d-une-clé-SSH)
|
||||
- [Guide Gitea SSH](https://docs.gitea.com/usage/ssh-setup)
|
||||
- [Bonnes pratiques SSH](https://www.ssh.com/academy/ssh/key)
|
||||
|
||||
---
|
||||
|
||||
**Dernière mise à jour** : $(date '+%Y-%m-%d')
|
||||
**Version** : 1.0.0
|
||||
@ -1,13 +0,0 @@
|
||||
# Support
|
||||
|
||||
Ce document décrit comment obtenir de l'aide et signaler des problèmes.
|
||||
|
||||
## Canaux
|
||||
|
||||
- Issues: utilisez le suivi d'issues du dépôt.
|
||||
- Sécurité: suivez la politique décrite dans `SECURITY.md`.
|
||||
|
||||
## Bonnes pratiques
|
||||
|
||||
- Fournir contexte, versions et étapes de reproduction.
|
||||
- Joindre des journaux pertinents sans secrets.
|
||||
490
docs/TESTING.md
490
docs/TESTING.md
@ -1,490 +0,0 @@
|
||||
# Guide de Tests - 4NK Node
|
||||
|
||||
Ce guide documente l'ensemble des tests disponibles pour l'infrastructure 4NK Node, leur organisation et leur utilisation.
|
||||
|
||||
## Vue d'Ensemble
|
||||
|
||||
L'infrastructure 4NK Node dispose d'une suite de tests complète organisée en plusieurs catégories :
|
||||
|
||||
- **Tests Unitaires** : Tests individuels des composants
|
||||
- **Tests d'Intégration** : Tests d'interaction entre services
|
||||
- **Tests de Connectivité** : Tests réseau et WebSocket
|
||||
- **Tests Externes** : Tests avec des nœuds externes
|
||||
- **Tests de Performance** : Tests de charge et performance (à venir)
|
||||
|
||||
## Structure des Tests
|
||||
|
||||
```
|
||||
tests/
|
||||
├── README.md # Documentation principale des tests
|
||||
├── run_all_tests.sh # Exécution de tous les tests
|
||||
├── run_unit_tests.sh # Tests unitaires uniquement
|
||||
├── run_integration_tests.sh # Tests d'intégration uniquement
|
||||
├── run_connectivity_tests.sh # Tests de connectivité uniquement
|
||||
├── run_external_tests.sh # Tests externes uniquement
|
||||
├── cleanup.sh # Nettoyage des logs et rapports
|
||||
├── logs/ # Logs des tests
|
||||
├── reports/ # Rapports de tests
|
||||
├── unit/ # Tests unitaires
|
||||
│ ├── test_healthcheck.sh
|
||||
│ ├── test_docker.sh
|
||||
│ ├── test_simple.sh
|
||||
│ └── test_final.sh
|
||||
├── integration/ # Tests d'intégration
|
||||
│ ├── test_3_relays.sh
|
||||
│ ├── test_final_sync.sh
|
||||
│ ├── test_sync_logs.sh
|
||||
│ └── test_messages.sh
|
||||
├── connectivity/ # Tests de connectivité
|
||||
│ ├── test_connectivity.sh
|
||||
│ └── test_websocket_messages.py
|
||||
├── external/ # Tests externes
|
||||
│ ├── test_dev3_simple.py
|
||||
│ ├── test_dev3_connectivity.py
|
||||
│ └── test_integration_dev3.sh
|
||||
└── performance/ # Tests de performance (à créer)
|
||||
```
|
||||
|
||||
## Exécution des Tests
|
||||
|
||||
### Test Complet
|
||||
|
||||
Pour exécuter tous les tests :
|
||||
|
||||
```bash
|
||||
cd tests/
|
||||
./run_all_tests.sh
|
||||
```
|
||||
|
||||
Options disponibles :
|
||||
- `--verbose` : Mode verbose avec affichage détaillé
|
||||
- `--debug` : Mode debug complet
|
||||
- `--skip-unit` : Ignorer les tests unitaires
|
||||
- `--skip-integration` : Ignorer les tests d'intégration
|
||||
- `--skip-connectivity` : Ignorer les tests de connectivité
|
||||
- `--skip-external` : Ignorer les tests externes
|
||||
|
||||
### Tests par Catégorie
|
||||
|
||||
#### Tests Unitaires
|
||||
```bash
|
||||
./tests/run_unit_tests.sh [--verbose] [--debug]
|
||||
```
|
||||
|
||||
**Tests inclus :**
|
||||
- `test_healthcheck.sh` : Test du healthcheck de sdk_relay
|
||||
- `test_docker.sh` : Test de la configuration Docker
|
||||
- `test_simple.sh` : Test simple de sdk_relay
|
||||
- `test_final.sh` : Test final de sdk_relay
|
||||
|
||||
**Prérequis :**
|
||||
- Docker installé et fonctionnel
|
||||
- Image sdk_relay disponible
|
||||
|
||||
#### Tests d'Intégration
|
||||
```bash
|
||||
./tests/run_integration_tests.sh [--verbose] [--debug]
|
||||
```
|
||||
|
||||
**Tests inclus :**
|
||||
- `test_3_relays.sh` : Test de 3 instances sdk_relay
|
||||
- `test_final_sync.sh` : Test complet de synchronisation
|
||||
- `test_sync_logs.sh` : Test des logs de synchronisation
|
||||
- `test_messages.sh` : Test des messages entre relais
|
||||
|
||||
**Prérequis :**
|
||||
- Tous les services Docker démarrés (bitcoin, blindbit, sdk_relay)
|
||||
- Infrastructure complète opérationnelle
|
||||
|
||||
#### Tests de Connectivité
|
||||
```bash
|
||||
./tests/run_connectivity_tests.sh [--verbose] [--debug]
|
||||
```
|
||||
|
||||
**Tests inclus :**
|
||||
- `test_connectivity.sh` : Test de connectivité des services
|
||||
- `test_websocket_messages.py` : Test des messages WebSocket
|
||||
|
||||
**Prérequis :**
|
||||
- Services Docker démarrés
|
||||
- Python3 avec websockets installé
|
||||
|
||||
#### Tests Externes
|
||||
```bash
|
||||
./tests/run_external_tests.sh [--verbose] [--debug]
|
||||
```
|
||||
|
||||
**Tests inclus :**
|
||||
- `test_dev3_simple.py` : Test simple de dev3.4nkweb.com
|
||||
- `test_dev3_connectivity.py` : Test de connectivité dev3
|
||||
- `test_integration_dev3.sh` : Test d'intégration dev3
|
||||
|
||||
**Prérequis :**
|
||||
- Connectivité internet
|
||||
- Python3 avec websockets installé
|
||||
- Services locaux optionnels
|
||||
|
||||
### Test Individuel
|
||||
|
||||
Pour exécuter un test spécifique :
|
||||
|
||||
```bash
|
||||
# Test shell
|
||||
./tests/integration/test_3_relays.sh
|
||||
|
||||
# Test Python
|
||||
python3 tests/external/test_dev3_simple.py
|
||||
```
|
||||
|
||||
## Interprétation des Résultats
|
||||
|
||||
### Codes de Sortie
|
||||
|
||||
- `0` : Test réussi
|
||||
- `1` : Test échoué
|
||||
- `2` : Test ignoré (prérequis non satisfaits)
|
||||
|
||||
### Logs
|
||||
|
||||
Les logs détaillés sont écrits dans `tests/logs/` avec le format :
|
||||
```
|
||||
YYYY-MM-DD_HH-MM-SS_category_tests.log
|
||||
```
|
||||
|
||||
Exemples :
|
||||
- `2024-12-19_14-30-25_unit_tests.log`
|
||||
- `2024-12-19_14-35-12_integration_tests.log`
|
||||
|
||||
### Rapports
|
||||
|
||||
Les rapports JSON sont générés dans `tests/reports/` avec le format :
|
||||
```
|
||||
test_report_YYYY-MM-DD_HH-MM-SS.json
|
||||
```
|
||||
|
||||
Structure du rapport :
|
||||
```json
|
||||
{
|
||||
"timestamp": "2024-12-19_14-30-25",
|
||||
"summary": {
|
||||
"total_tests": 10,
|
||||
"successful_tests": 8,
|
||||
"failed_tests": 2,
|
||||
"success_rate": 80.0
|
||||
},
|
||||
"log_file": "tests/logs/test_run_2024-12-19_14-30-25.log",
|
||||
"options": {
|
||||
"verbose": false,
|
||||
"debug": false,
|
||||
"skip_unit": false,
|
||||
"skip_integration": false,
|
||||
"skip_connectivity": false,
|
||||
"skip_external": false,
|
||||
"skip_performance": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Détail des Tests
|
||||
|
||||
### Tests Unitaires
|
||||
|
||||
#### test_healthcheck.sh
|
||||
- **Objectif** : Vérifier le fonctionnement du healthcheck de sdk_relay
|
||||
- **Méthode** : Test du script healthcheck.sh dans un conteneur
|
||||
- **Critères de succès** : Healthcheck retourne un code de sortie approprié
|
||||
|
||||
#### test_docker.sh
|
||||
- **Objectif** : Vérifier la configuration Docker de sdk_relay
|
||||
- **Méthode** : Test de la construction et du démarrage du conteneur
|
||||
- **Critères de succès** : Conteneur démarre correctement
|
||||
|
||||
#### test_simple.sh
|
||||
- **Objectif** : Test simple de sdk_relay
|
||||
- **Méthode** : Démarrage et test basique de sdk_relay
|
||||
- **Critères de succès** : Service répond aux requêtes de base
|
||||
|
||||
#### test_final.sh
|
||||
- **Objectif** : Test final complet de sdk_relay
|
||||
- **Méthode** : Test complet avec toutes les fonctionnalités
|
||||
- **Critères de succès** : Toutes les fonctionnalités opérationnelles
|
||||
|
||||
### Tests d'Intégration
|
||||
|
||||
#### test_3_relays.sh
|
||||
- **Objectif** : Tester 3 instances sdk_relay en parallèle
|
||||
- **Méthode** : Démarrage de 3 relais et vérification de leur interaction
|
||||
- **Critères de succès** : Les 3 relais communiquent correctement
|
||||
|
||||
#### test_final_sync.sh
|
||||
- **Objectif** : Test complet de la synchronisation
|
||||
- **Méthode** : Test de tous les types de synchronisation
|
||||
- **Critères de succès** : Synchronisation fonctionnelle entre tous les relais
|
||||
|
||||
#### test_sync_logs.sh
|
||||
- **Objectif** : Vérifier les logs de synchronisation
|
||||
- **Méthode** : Analyse des logs de synchronisation
|
||||
- **Critères de succès** : Logs cohérents et sans erreurs
|
||||
|
||||
#### test_messages.sh
|
||||
- **Objectif** : Tester l'échange de messages entre relais
|
||||
- **Méthode** : Envoi et réception de messages de test
|
||||
- **Critères de succès** : Messages correctement transmis
|
||||
|
||||
### Tests de Connectivité
|
||||
|
||||
#### test_connectivity.sh
|
||||
- **Objectif** : Vérifier la connectivité entre services
|
||||
- **Méthode** : Test de connectivité réseau entre conteneurs
|
||||
- **Critères de succès** : Tous les services accessibles
|
||||
|
||||
#### test_websocket_messages.py
|
||||
- **Objectif** : Tester les messages WebSocket
|
||||
- **Méthode** : Connexion WebSocket et échange de messages
|
||||
- **Critères de succès** : Communication WebSocket fonctionnelle
|
||||
|
||||
### Tests Externes
|
||||
|
||||
#### test_dev3_simple.py
|
||||
- **Objectif** : Test simple de dev3.4nkweb.com
|
||||
- **Méthode** : Connexion WebSocket simple
|
||||
- **Critères de succès** : Connexion établie
|
||||
|
||||
#### test_dev3_connectivity.py
|
||||
- **Objectif** : Test complet de connectivité dev3
|
||||
- **Méthode** : Tests de protocole et handshake
|
||||
- **Critères de succès** : Tous les protocoles supportés
|
||||
|
||||
#### test_integration_dev3.sh
|
||||
- **Objectif** : Test d'intégration avec dev3
|
||||
- **Méthode** : Test complet d'intégration
|
||||
- **Critères de succès** : Intégration fonctionnelle
|
||||
|
||||
## Dépannage
|
||||
|
||||
### Problèmes Courants
|
||||
|
||||
#### Services non démarrés
|
||||
**Symptôme** : Erreur "Service non trouvé"
|
||||
**Solution** : Démarrer les services avec `./restart_4nk_node.sh`
|
||||
|
||||
#### Connectivité réseau
|
||||
**Symptôme** : Timeout ou erreur de connexion
|
||||
**Solution** : Vérifier les ports et pare-feu
|
||||
|
||||
#### Certificats SSL
|
||||
**Symptôme** : Erreur SSL dans les tests externes
|
||||
**Solution** : Vérifier les certificats et la configuration SSL
|
||||
|
||||
#### Dépendances Python
|
||||
**Symptôme** : ModuleNotFoundError
|
||||
**Solution** : Installer les dépendances avec `pip install websockets`
|
||||
|
||||
### Debug
|
||||
|
||||
#### Mode Verbose
|
||||
```bash
|
||||
./tests/run_all_tests.sh --verbose
|
||||
```
|
||||
|
||||
#### Mode Debug
|
||||
```bash
|
||||
./tests/run_all_tests.sh --debug
|
||||
```
|
||||
|
||||
#### Test spécifique avec debug
|
||||
```bash
|
||||
./tests/integration/test_3_relays.sh --debug
|
||||
```
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Nettoyage Automatique
|
||||
|
||||
#### Nettoyer les logs anciens
|
||||
```bash
|
||||
./tests/cleanup.sh --days 7
|
||||
```
|
||||
|
||||
#### Nettoyer les rapports anciens
|
||||
```bash
|
||||
./tests/cleanup.sh --reports --days 30
|
||||
```
|
||||
|
||||
#### Nettoyage complet
|
||||
```bash
|
||||
./tests/cleanup.sh --all --days 7
|
||||
```
|
||||
|
||||
#### Simulation de nettoyage
|
||||
```bash
|
||||
./tests/cleanup.sh --all --dry-run
|
||||
```
|
||||
|
||||
### Surveillance
|
||||
|
||||
#### Vérifier l'espace disque
|
||||
```bash
|
||||
du -sh tests/logs tests/reports
|
||||
```
|
||||
|
||||
#### Lister les fichiers récents
|
||||
```bash
|
||||
find tests/logs -name "*.log" -mtime -1
|
||||
```
|
||||
|
||||
#### Analyser les échecs
|
||||
```bash
|
||||
grep -r "ERROR\|FAILED" tests/logs/
|
||||
```
|
||||
|
||||
## Ajout de Nouveaux Tests
|
||||
|
||||
### Structure Recommandée
|
||||
|
||||
Pour ajouter un nouveau test :
|
||||
|
||||
1. **Créer le fichier de test** dans le répertoire approprié
|
||||
2. **Ajouter le test** au script d'exécution correspondant
|
||||
3. **Documenter le test** dans ce guide
|
||||
4. **Tester le test** pour s'assurer qu'il fonctionne
|
||||
|
||||
### Template de Test Shell
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# Test: Description du test
|
||||
# Auteur: Nom
|
||||
# Date: YYYY-MM-DD
|
||||
|
||||
set -e
|
||||
|
||||
# Configuration
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
LOG_FILE="tests/logs/$(date +%Y-%m-%d_%H-%M-%S)_test_name.log"
|
||||
|
||||
# Fonctions
|
||||
log() {
|
||||
echo "[$(date +%Y-%m-%d\ %H:%M:%S)] $1" | tee -a "$LOG_FILE"
|
||||
}
|
||||
|
||||
# Test principal
|
||||
main() {
|
||||
log "Début du test"
|
||||
|
||||
# Vérifications préliminaires
|
||||
check_prerequisites
|
||||
|
||||
# Exécution du test
|
||||
run_test
|
||||
|
||||
# Vérification des résultats
|
||||
verify_results
|
||||
|
||||
log "Test terminé avec succès"
|
||||
}
|
||||
|
||||
# Exécution
|
||||
main "$@"
|
||||
```
|
||||
|
||||
### Template de Test Python
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Test: Description du test
|
||||
Auteur: Nom
|
||||
Date: YYYY-MM-DD
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
from datetime import datetime
|
||||
|
||||
# Configuration du logging
|
||||
logging.basicConfig(level=logging.INFO)
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
async def test_function():
|
||||
"""Fonction de test principale"""
|
||||
logger.info("Début du test")
|
||||
|
||||
try:
|
||||
# Logique de test
|
||||
result = await run_test()
|
||||
|
||||
# Vérification
|
||||
if result:
|
||||
logger.info("Test réussi")
|
||||
return True
|
||||
else:
|
||||
logger.error("Test échoué")
|
||||
return False
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Erreur lors du test: {e}")
|
||||
return False
|
||||
|
||||
async def main():
|
||||
"""Fonction principale"""
|
||||
success = await test_function()
|
||||
exit(0 if success else 1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
## Intégration Continue
|
||||
|
||||
### Automatisation
|
||||
|
||||
Les tests peuvent être intégrés dans un pipeline CI/CD :
|
||||
|
||||
```yaml
|
||||
# Exemple GitHub Actions
|
||||
- name: Run Tests
|
||||
run: |
|
||||
cd tests/
|
||||
./run_all_tests.sh --verbose
|
||||
```
|
||||
|
||||
### Surveillance Continue
|
||||
|
||||
Pour une surveillance continue :
|
||||
|
||||
```bash
|
||||
# Cron job pour tests quotidiens
|
||||
0 2 * * * cd /path/to/4NK_node/tests && ./run_all_tests.sh >> /var/log/4nk_tests.log 2>&1
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
Pour obtenir de l'aide :
|
||||
|
||||
1. **Consulter les logs** : `tests/logs/`
|
||||
2. **Vérifier la documentation** : `tests/README.md`
|
||||
3. **Utiliser le mode debug** : `--debug`
|
||||
4. **Consulter les rapports** : `tests/reports/`
|
||||
|
||||
## Évolution
|
||||
|
||||
### Tests de Performance (À venir)
|
||||
|
||||
- Tests de charge
|
||||
- Tests de latence
|
||||
- Tests de débit
|
||||
- Tests de stress
|
||||
|
||||
### Tests de Sécurité (À venir)
|
||||
|
||||
- Tests de vulnérabilités
|
||||
- Tests de pénétration
|
||||
- Tests de configuration
|
||||
|
||||
### Tests d'Interface (À venir)
|
||||
|
||||
- Tests d'API REST
|
||||
- Tests d'interface WebSocket
|
||||
- Tests de compatibilité
|
||||
545
docs/USAGE.md
545
docs/USAGE.md
@ -1,545 +0,0 @@
|
||||
# 📖 Guide d'Utilisation - sdk_common
|
||||
|
||||
Guide complet pour utiliser la bibliothèque commune sdk_common pour les Silent Payments.
|
||||
|
||||
## 🚀 Compilation et Build
|
||||
|
||||
### 1. Build de Développement
|
||||
|
||||
```bash
|
||||
# Build de base
|
||||
cargo build
|
||||
|
||||
# Build avec toutes les features
|
||||
cargo build --all-features
|
||||
|
||||
# Build avec une feature spécifique
|
||||
cargo build --features wasm
|
||||
cargo build --features blindbit-wasm
|
||||
```
|
||||
|
||||
### 2. Build de Production
|
||||
|
||||
```bash
|
||||
# Build optimisé
|
||||
cargo build --release
|
||||
|
||||
# Build avec optimisations avancées
|
||||
RUSTFLAGS="-C target-cpu=native" cargo build --release
|
||||
|
||||
# Build avec LTO
|
||||
RUSTFLAGS="-C lto=fat" cargo build --release
|
||||
```
|
||||
|
||||
### 3. Build WASM
|
||||
|
||||
```bash
|
||||
# Build WASM pour le web
|
||||
wasm-pack build --target web
|
||||
|
||||
# Build WASM pour Node.js
|
||||
wasm-pack build --target nodejs
|
||||
|
||||
# Build WASM avec optimisations
|
||||
wasm-pack build --target web --release
|
||||
```
|
||||
|
||||
## 🔧 Intégration dans les Projets
|
||||
|
||||
### 1. Intégration Rust
|
||||
|
||||
**Dans `Cargo.toml` :**
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", branch = "main" }
|
||||
|
||||
# Avec features spécifiques
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["wasm"] }
|
||||
```
|
||||
|
||||
**Utilisation dans le code :**
|
||||
|
||||
```rust
|
||||
use sdk_common::{
|
||||
types::{Wallet, Transaction, SilentPayment},
|
||||
traits::WalletOperations,
|
||||
error::SdkError
|
||||
};
|
||||
|
||||
fn main() -> Result<(), SdkError> {
|
||||
// Créer un wallet
|
||||
let wallet = Wallet::new()?;
|
||||
|
||||
// Générer un paiement silencieux
|
||||
let payment = SilentPayment::generate(&wallet)?;
|
||||
|
||||
// Traiter une transaction
|
||||
let tx = Transaction::from_hex("...")?;
|
||||
let result = wallet.process_transaction(&tx)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Intégration JavaScript/TypeScript
|
||||
|
||||
**Installation :**
|
||||
|
||||
```bash
|
||||
npm install @4nk/sdk-common
|
||||
```
|
||||
|
||||
**Utilisation :**
|
||||
|
||||
```javascript
|
||||
import { init, Wallet, SilentPayment } from '@4nk/sdk-common';
|
||||
|
||||
async function main() {
|
||||
// Initialiser le module WASM
|
||||
await init();
|
||||
|
||||
// Créer un wallet
|
||||
const wallet = new Wallet();
|
||||
|
||||
// Générer un paiement silencieux
|
||||
const payment = SilentPayment.generate(wallet);
|
||||
|
||||
console.log('Payment:', payment);
|
||||
}
|
||||
|
||||
main().catch(console.error);
|
||||
```
|
||||
|
||||
### 3. Intégration Web
|
||||
|
||||
**HTML :**
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>SDK Common Demo</title>
|
||||
</head>
|
||||
<body>
|
||||
<script type="module">
|
||||
import init, { Wallet, SilentPayment } from './pkg/sdk_common.js';
|
||||
|
||||
async function main() {
|
||||
await init();
|
||||
|
||||
const wallet = new Wallet();
|
||||
const payment = SilentPayment.generate(wallet);
|
||||
|
||||
document.getElementById('result').textContent =
|
||||
JSON.stringify(payment, null, 2);
|
||||
}
|
||||
|
||||
main();
|
||||
</script>
|
||||
|
||||
<h1>SDK Common Demo</h1>
|
||||
<pre id="result"></pre>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## 📚 Utilisation des Types et Structures
|
||||
|
||||
### 1. Types de Base
|
||||
|
||||
```rust
|
||||
use sdk_common::types::*;
|
||||
|
||||
// Wallet
|
||||
let wallet = Wallet::new()?;
|
||||
let public_key = wallet.public_key();
|
||||
let private_key = wallet.private_key();
|
||||
|
||||
// Silent Payment
|
||||
let payment = SilentPayment::new(&wallet)?;
|
||||
let address = payment.address();
|
||||
let scan_key = payment.scan_key();
|
||||
|
||||
// Transaction
|
||||
let tx = Transaction::from_hex("...")?;
|
||||
let txid = tx.txid();
|
||||
let outputs = tx.outputs();
|
||||
```
|
||||
|
||||
### 2. Traits et Interfaces
|
||||
|
||||
```rust
|
||||
use sdk_common::traits::*;
|
||||
|
||||
// Implémentation de WalletOperations
|
||||
impl WalletOperations for MyWallet {
|
||||
fn generate_address(&self) -> Result<Address, SdkError> {
|
||||
// Implémentation personnalisée
|
||||
}
|
||||
|
||||
fn sign_transaction(&self, tx: &Transaction) -> Result<Signature, SdkError> {
|
||||
// Implémentation personnalisée
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Gestion des Erreurs
|
||||
|
||||
```rust
|
||||
use sdk_common::error::SdkError;
|
||||
|
||||
fn process_payment(payment_data: &str) -> Result<(), SdkError> {
|
||||
match SilentPayment::from_json(payment_data) {
|
||||
Ok(payment) => {
|
||||
// Traitement réussi
|
||||
Ok(())
|
||||
}
|
||||
Err(SdkError::InvalidFormat) => {
|
||||
eprintln!("Format de paiement invalide");
|
||||
Err(SdkError::InvalidFormat)
|
||||
}
|
||||
Err(SdkError::NetworkError) => {
|
||||
eprintln!("Erreur réseau");
|
||||
Err(SdkError::NetworkError)
|
||||
}
|
||||
Err(e) => {
|
||||
eprintln!("Erreur inattendue: {:?}", e);
|
||||
Err(e)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🧪 Tests et Validation
|
||||
|
||||
### 1. Tests Unitaires
|
||||
|
||||
```bash
|
||||
# Tests de base
|
||||
cargo test
|
||||
|
||||
# Tests avec output détaillé
|
||||
cargo test -- --nocapture
|
||||
|
||||
# Tests d'une fonction spécifique
|
||||
cargo test test_wallet_creation
|
||||
|
||||
# Tests avec couverture
|
||||
cargo tarpaulin --out Html
|
||||
```
|
||||
|
||||
### 2. Tests d'Intégration
|
||||
|
||||
```bash
|
||||
# Tests d'intégration
|
||||
cargo test --test integration
|
||||
|
||||
# Tests de performance
|
||||
cargo test --test performance
|
||||
|
||||
# Tests de sécurité
|
||||
cargo test --test security
|
||||
```
|
||||
|
||||
### 3. Tests WASM
|
||||
|
||||
```bash
|
||||
# Tests WASM avec Firefox
|
||||
wasm-pack test --headless --firefox
|
||||
|
||||
# Tests WASM avec Chrome
|
||||
wasm-pack test --headless --chrome
|
||||
|
||||
# Tests WASM avec Node.js
|
||||
wasm-pack test --node
|
||||
```
|
||||
|
||||
### 4. Tests de Compatibilité
|
||||
|
||||
```bash
|
||||
# Tests de compatibilité avec sdk_client
|
||||
cargo test --features sdk-client
|
||||
|
||||
# Tests de compatibilité avec sdk_relay
|
||||
cargo test --features sdk-relay
|
||||
|
||||
# Tests de compatibilité WASM
|
||||
cargo test --features wasm
|
||||
```
|
||||
|
||||
## ⚙️ Configuration et Maintenance
|
||||
|
||||
### 1. Configuration des Features
|
||||
|
||||
**Activation des features :**
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["wasm", "blindbit-wasm"] }
|
||||
```
|
||||
|
||||
**Features disponibles :**
|
||||
|
||||
- `std` : Support standard (par défaut)
|
||||
- `wasm` : Support WebAssembly
|
||||
- `blindbit-wasm` : Support Blindbit en WASM
|
||||
- `sdk-client` : Compatibilité avec sdk_client
|
||||
- `sdk-relay` : Compatibilité avec sdk_relay
|
||||
|
||||
### 2. Configuration de Build
|
||||
|
||||
**Optimisations de performance :**
|
||||
|
||||
```bash
|
||||
# Compilation optimisée
|
||||
RUSTFLAGS="-C target-cpu=native -C lto=fat" cargo build --release
|
||||
|
||||
# Compilation avec sanitizers
|
||||
RUSTFLAGS="-Z sanitizer=address" cargo test
|
||||
|
||||
# Compilation avec vérifications
|
||||
RUSTFLAGS="-C overflow-checks=on" cargo build
|
||||
```
|
||||
|
||||
### 3. Configuration des Tests
|
||||
|
||||
**Variables d'environnement pour les tests :**
|
||||
|
||||
```bash
|
||||
# Timeout des tests
|
||||
export TEST_TIMEOUT=300
|
||||
|
||||
# Tests parallèles
|
||||
export TEST_PARALLEL=true
|
||||
|
||||
# Logs détaillés
|
||||
export RUST_LOG=debug
|
||||
|
||||
# Backtrace
|
||||
export RUST_BACKTRACE=1
|
||||
```
|
||||
|
||||
## 🚀 Optimisations de Performance
|
||||
|
||||
### 1. Optimisations Rust
|
||||
|
||||
```rust
|
||||
// Utilisation de references pour éviter les copies
|
||||
fn process_wallet(wallet: &Wallet) -> Result<(), SdkError> {
|
||||
// Traitement optimisé
|
||||
}
|
||||
|
||||
// Utilisation de iterators pour les performances
|
||||
fn process_transactions(txs: &[Transaction]) -> Vec<Result<(), SdkError>> {
|
||||
txs.iter().map(|tx| process_transaction(tx)).collect()
|
||||
}
|
||||
|
||||
// Utilisation de Box pour les gros objets
|
||||
fn create_large_wallet() -> Box<Wallet> {
|
||||
Box::new(Wallet::new().unwrap())
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Optimisations WASM
|
||||
|
||||
```javascript
|
||||
// Initialisation asynchrone
|
||||
const sdk = await init();
|
||||
|
||||
// Utilisation de Web Workers pour les calculs lourds
|
||||
const worker = new Worker('sdk-worker.js');
|
||||
worker.postMessage({ type: 'process_payment', data: paymentData });
|
||||
|
||||
// Utilisation de SharedArrayBuffer pour les gros datasets
|
||||
const sharedBuffer = new SharedArrayBuffer(1024 * 1024);
|
||||
```
|
||||
|
||||
### 3. Optimisations de Build
|
||||
|
||||
```bash
|
||||
# Build avec optimisations avancées
|
||||
RUSTFLAGS="-C target-cpu=native -C lto=fat -C codegen-units=1" cargo build --release
|
||||
|
||||
# Build WASM optimisé
|
||||
wasm-pack build --target web --release -- --no-default-features
|
||||
|
||||
# Minification WASM
|
||||
wasm-opt -O4 -o pkg/sdk_common_bg.wasm pkg/sdk_common_bg.wasm
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
### 1. Validation des Entrées
|
||||
|
||||
```rust
|
||||
use sdk_common::validation::*;
|
||||
|
||||
// Validation des adresses
|
||||
fn validate_address(address: &str) -> Result<(), SdkError> {
|
||||
if !is_valid_bitcoin_address(address) {
|
||||
return Err(SdkError::InvalidAddress);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// Validation des transactions
|
||||
fn validate_transaction(tx_hex: &str) -> Result<(), SdkError> {
|
||||
if !is_valid_transaction_hex(tx_hex) {
|
||||
return Err(SdkError::InvalidTransaction);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Gestion de la Mémoire
|
||||
|
||||
```rust
|
||||
// Utilisation de zeroize pour les données sensibles
|
||||
use zeroize::Zeroize;
|
||||
|
||||
struct SecureWallet {
|
||||
private_key: Vec<u8>,
|
||||
}
|
||||
|
||||
impl Drop for SecureWallet {
|
||||
fn drop(&mut self) {
|
||||
self.private_key.zeroize();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Protection contre les Attaques
|
||||
|
||||
```rust
|
||||
// Protection contre les attaques par timing
|
||||
use subtle::ConstantTimeEq;
|
||||
|
||||
fn verify_signature(sig1: &[u8], sig2: &[u8]) -> bool {
|
||||
sig1.ct_eq(sig2).unwrap_u8() == 1
|
||||
}
|
||||
|
||||
// Protection contre les attaques par déni de service
|
||||
fn process_with_timeout<F, T>(f: F, timeout: Duration) -> Result<T, SdkError>
|
||||
where
|
||||
F: FnOnce() -> Result<T, SdkError>,
|
||||
{
|
||||
// Implémentation avec timeout
|
||||
}
|
||||
```
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### 1. Métriques de Performance
|
||||
|
||||
```rust
|
||||
use std::time::Instant;
|
||||
|
||||
fn benchmark_operation() {
|
||||
let start = Instant::now();
|
||||
|
||||
// Opération à mesurer
|
||||
let result = perform_operation();
|
||||
|
||||
let duration = start.elapsed();
|
||||
println!("Opération terminée en {:?}", duration);
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Logs et Debug
|
||||
|
||||
```rust
|
||||
use log::{info, warn, error, debug};
|
||||
|
||||
fn process_payment(payment: &SilentPayment) -> Result<(), SdkError> {
|
||||
debug!("Traitement du paiement: {:?}", payment);
|
||||
|
||||
match payment.process() {
|
||||
Ok(_) => {
|
||||
info!("Paiement traité avec succès");
|
||||
Ok(())
|
||||
}
|
||||
Err(e) => {
|
||||
error!("Erreur lors du traitement: {:?}", e);
|
||||
Err(e)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Métriques de Build
|
||||
|
||||
```bash
|
||||
# Taille du binaire
|
||||
ls -lh target/release/libsdk_common.*
|
||||
|
||||
# Taille WASM
|
||||
ls -lh pkg/sdk_common_bg.wasm
|
||||
|
||||
# Temps de compilation
|
||||
time cargo build --release
|
||||
|
||||
# Analyse des dépendances
|
||||
cargo tree
|
||||
```
|
||||
|
||||
## 🔄 Mises à Jour
|
||||
|
||||
### 1. Mise à Jour de la Bibliothèque
|
||||
|
||||
```bash
|
||||
# Mettre à jour les dépendances
|
||||
cargo update
|
||||
|
||||
# Vérifier les vulnérabilités
|
||||
cargo audit
|
||||
|
||||
# Tester après mise à jour
|
||||
cargo test --all
|
||||
```
|
||||
|
||||
### 2. Migration des Versions
|
||||
|
||||
```rust
|
||||
// Gestion des breaking changes
|
||||
#[cfg(feature = "v2")]
|
||||
use sdk_common::v2::{Wallet, SilentPayment};
|
||||
|
||||
#[cfg(not(feature = "v2"))]
|
||||
use sdk_common::v1::{Wallet, SilentPayment};
|
||||
```
|
||||
|
||||
### 3. Migration des Données
|
||||
|
||||
```rust
|
||||
// Migration des wallets
|
||||
fn migrate_wallet_v1_to_v2(wallet_v1: V1Wallet) -> Result<V2Wallet, SdkError> {
|
||||
// Logique de migration
|
||||
let wallet_v2 = V2Wallet::from_v1(wallet_v1)?;
|
||||
Ok(wallet_v2)
|
||||
}
|
||||
```
|
||||
|
||||
## 🎯 Prochaines Étapes
|
||||
|
||||
### 1. Intégration
|
||||
|
||||
- [Guide de Configuration](CONFIGURATION.md) - Configurer selon vos besoins
|
||||
- [API Reference](API.md) - Consulter les APIs détaillées
|
||||
- [Architecture](ARCHITECTURE.md) - Comprendre l'architecture
|
||||
|
||||
### 2. Développement
|
||||
|
||||
- [Guide de Développement](DEVELOPMENT.md) - Contribuer au développement
|
||||
- [Guide des Tests](TESTING.md) - Écrire et exécuter des tests
|
||||
- [Quick Reference](QUICK_REFERENCE.md) - Référence rapide
|
||||
|
||||
### 3. Intégration avec 4NK_node
|
||||
|
||||
- [Intégration 4NK_node](INTEGRATION_4NK_NODE.md) - Intégrer avec l'infrastructure
|
||||
- [Configuration SSH](SSH_SETUP.md) - Configurer SSH pour l'automatisation
|
||||
- [Push SSH Automatisé](AUTO_SSH_PUSH.md) - Automatiser les déploiements
|
||||
|
||||
---
|
||||
|
||||
**📖 La bibliothèque sdk_common est maintenant prête à être utilisée dans vos projets !** 🚀
|
||||
0
migrations.toml
Normal file
0
migrations.toml
Normal file
@ -1,155 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Script d'automatisation des push SSH pour ihm_client
|
||||
# Utilise automatiquement la clé SSH pour tous les push
|
||||
|
||||
set -e
|
||||
|
||||
echo "🔑 Configuration automatique SSH pour push ihm_client..."
|
||||
|
||||
# Configuration SSH automatique
|
||||
echo "⚙️ Configuration Git pour utiliser SSH..."
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
|
||||
# Vérifier la configuration SSH
|
||||
echo "🔍 Vérification de la configuration SSH..."
|
||||
if ! ssh -T git@git.4nkweb.com 2>&1 | grep -q "successfully authenticated"; then
|
||||
echo "❌ Échec de l'authentification SSH"
|
||||
echo "💡 Vérifiez que votre clé SSH est configurée :"
|
||||
echo " 1. ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk"
|
||||
echo " 2. Ajouter la clé publique à votre compte Gitea"
|
||||
echo " 3. ssh-add ~/.ssh/id_ed25519_4nk"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ Authentification SSH réussie"
|
||||
|
||||
# Fonction pour push automatique
|
||||
auto_push() {
|
||||
local branch=${1:-$(git branch --show-current)}
|
||||
local commit_message=${2:-"Auto-commit $(date '+%Y-%m-%d %H:%M:%S')"}
|
||||
|
||||
echo "🚀 Push automatique sur la branche: $branch"
|
||||
|
||||
# Ajouter tous les changements
|
||||
git add .
|
||||
|
||||
# Commiter avec le message fourni
|
||||
git commit -m "$commit_message"
|
||||
|
||||
# Push avec SSH automatique
|
||||
echo "📤 Push vers origin/$branch..."
|
||||
git push origin "$branch"
|
||||
|
||||
echo "✅ Push réussi !"
|
||||
}
|
||||
|
||||
# Fonction pour push avec message personnalisé
|
||||
push_with_message() {
|
||||
local message="$1"
|
||||
local branch=${2:-$(git branch --show-current)}
|
||||
|
||||
echo "💬 Push avec message: $message"
|
||||
auto_push "$branch" "$message"
|
||||
}
|
||||
|
||||
# Fonction pour push rapide (sans message)
|
||||
quick_push() {
|
||||
local branch=${1:-$(git branch --show-current)}
|
||||
auto_push "$branch"
|
||||
}
|
||||
|
||||
# Fonction pour push sur une branche spécifique
|
||||
push_branch() {
|
||||
local branch="$1"
|
||||
local message=${2:-"Update $branch $(date '+%Y-%m-%d %H:%M:%S')"}
|
||||
|
||||
echo "🌿 Push sur la branche: $branch"
|
||||
auto_push "$branch" "$message"
|
||||
}
|
||||
|
||||
# Fonction pour push et merge vers main
|
||||
push_and_merge() {
|
||||
local source_branch=${1:-$(git branch --show-current)}
|
||||
local target_branch=${2:-main}
|
||||
|
||||
echo "🔄 Push et merge $source_branch -> $target_branch"
|
||||
|
||||
# Push de la branche source
|
||||
auto_push "$source_branch"
|
||||
|
||||
# Demander confirmation pour le merge
|
||||
read -p "Voulez-vous créer une Pull Request pour merger vers $target_branch ? (y/N): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
echo "🔗 Création de la Pull Request..."
|
||||
echo "💡 Allez sur: https://git.4nkweb.com/4nk/ihm_client/compare/$target_branch...$source_branch"
|
||||
fi
|
||||
}
|
||||
|
||||
# Fonction pour status et push conditionnel
|
||||
status_and_push() {
|
||||
echo "📊 Statut du repository:"
|
||||
git status --short
|
||||
|
||||
if [[ -n $(git status --porcelain) ]]; then
|
||||
echo "📝 Changements détectés, push automatique..."
|
||||
auto_push
|
||||
else
|
||||
echo "✅ Aucun changement à pousser"
|
||||
fi
|
||||
}
|
||||
|
||||
# Menu interactif si aucun argument fourni
|
||||
if [[ $# -eq 0 ]]; then
|
||||
echo "🤖 Script de push SSH automatique pour ihm_client"
|
||||
echo ""
|
||||
echo "Options disponibles:"
|
||||
echo " auto-push.sh quick - Push rapide"
|
||||
echo " auto-push.sh message \"Mon message\" - Push avec message"
|
||||
echo " auto-push.sh branch nom-branche - Push sur branche spécifique"
|
||||
echo " auto-push.sh merge [source] [target] - Push et préparation merge"
|
||||
echo " auto-push.sh status - Status et push conditionnel"
|
||||
echo ""
|
||||
echo "Exemples:"
|
||||
echo " ./scripts/auto-ssh-push.sh quick"
|
||||
echo " ./scripts/auto-ssh-push.sh message \"feat: nouvelle fonctionnalité\""
|
||||
echo " ./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite"
|
||||
echo " ./scripts/auto-ssh-push.sh merge feature/nouvelle-fonctionnalite main"
|
||||
echo ""
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Traitement des arguments
|
||||
case "$1" in
|
||||
"quick")
|
||||
quick_push
|
||||
;;
|
||||
"message")
|
||||
if [[ -z "$2" ]]; then
|
||||
echo "❌ Message requis pour l'option 'message'"
|
||||
exit 1
|
||||
fi
|
||||
push_with_message "$2"
|
||||
;;
|
||||
"branch")
|
||||
if [[ -z "$2" ]]; then
|
||||
echo "❌ Nom de branche requis pour l'option 'branch'"
|
||||
exit 1
|
||||
fi
|
||||
push_branch "$2" "$3"
|
||||
;;
|
||||
"merge")
|
||||
push_and_merge "$2" "$3"
|
||||
;;
|
||||
"status")
|
||||
status_and_push
|
||||
;;
|
||||
*)
|
||||
echo "❌ Option inconnue: $1"
|
||||
echo "💡 Utilisez './scripts/auto-ssh-push.sh' pour voir les options"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
echo "🎯 Push SSH automatique terminé !"
|
||||
@ -1,152 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Script d'initialisation de l'environnement SSH pour ihm_client
|
||||
# Configure automatiquement SSH pour tous les push
|
||||
|
||||
set -e
|
||||
|
||||
echo "🚀 Initialisation de l'environnement SSH pour ihm_client..."
|
||||
|
||||
# Couleurs pour les messages
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Fonction pour afficher les messages colorés
|
||||
print_status() {
|
||||
echo -e "${BLUE}[INFO]${NC} $1"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}[SUCCESS]${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}[WARNING]${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}[ERROR]${NC} $1"
|
||||
}
|
||||
|
||||
# Vérifier si on est dans le bon répertoire
|
||||
if [[ ! -f "package.json" ]] || [[ ! -d ".git" ]]; then
|
||||
print_error "Ce script doit être exécuté depuis le répertoire racine de ihm_client"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
print_status "Configuration de l'environnement SSH..."
|
||||
|
||||
# 1. Configuration Git pour SSH
|
||||
print_status "Configuration Git pour utiliser SSH..."
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
|
||||
# 2. Vérifier si une clé SSH existe
|
||||
print_status "Vérification des clés SSH existantes..."
|
||||
if [[ -f ~/.ssh/id_rsa ]] || [[ -f ~/.ssh/id_ed25519 ]]; then
|
||||
print_success "Clé SSH trouvée"
|
||||
SSH_KEY_EXISTS=true
|
||||
else
|
||||
print_warning "Aucune clé SSH trouvée"
|
||||
SSH_KEY_EXISTS=false
|
||||
fi
|
||||
|
||||
# 3. Tester la connexion SSH
|
||||
print_status "Test de la connexion SSH vers git.4nkweb.com..."
|
||||
if ssh -T git@git.4nkweb.com 2>&1 | grep -q "successfully authenticated"; then
|
||||
print_success "Authentification SSH réussie"
|
||||
SSH_WORKING=true
|
||||
else
|
||||
print_error "Échec de l'authentification SSH"
|
||||
SSH_WORKING=false
|
||||
fi
|
||||
|
||||
# 4. Configuration des alias Git
|
||||
print_status "Configuration des alias Git..."
|
||||
git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto-commit $(date)}" && git push origin $(git branch --show-current); }; f'
|
||||
git config --global alias.quick-push '!f() { git add . && git commit -m "Update $(date)" && git push origin $(git branch --show-current); }; f'
|
||||
|
||||
print_success "Alias Git configurés"
|
||||
|
||||
# 5. Vérifier les remotes
|
||||
print_status "Vérification des remotes Git..."
|
||||
if git remote -v | grep -q "git@git.4nkweb.com"; then
|
||||
print_success "Remotes configurés pour SSH"
|
||||
else
|
||||
print_warning "Remotes non configurés pour SSH"
|
||||
print_status "Mise à jour des remotes..."
|
||||
git remote set-url origin git@git.4nkweb.com:4nk/ihm_client.git
|
||||
print_success "Remotes mis à jour"
|
||||
fi
|
||||
|
||||
# 6. Rendre les scripts exécutables
|
||||
print_status "Configuration des permissions des scripts..."
|
||||
chmod +x scripts/auto-ssh-push.sh 2>/dev/null || true
|
||||
chmod +x scripts/setup-ssh-ci.sh 2>/dev/null || true
|
||||
|
||||
print_success "Scripts rendus exécutables"
|
||||
|
||||
# 7. Créer un fichier de configuration local
|
||||
print_status "Création du fichier de configuration local..."
|
||||
cat > .ssh-config << EOF
|
||||
# Configuration SSH automatique pour ihm_client
|
||||
# Généré le $(date)
|
||||
|
||||
# Configuration Git
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
|
||||
# Alias Git
|
||||
git config --global alias.ssh-push '!f() { git add . && git commit -m "\${1:-Auto-commit \$(date)}" && git push origin \$(git branch --show-current); }; f'
|
||||
git config --global alias.quick-push '!f() { git add . && git commit -m "Update \$(date)" && git push origin \$(git branch --show-current); }; f'
|
||||
|
||||
# Test SSH
|
||||
ssh -T git@git.4nkweb.com
|
||||
|
||||
# Scripts disponibles
|
||||
./scripts/auto-ssh-push.sh quick
|
||||
./scripts/auto-ssh-push.sh message "Mon message"
|
||||
git ssh-push "Mon message"
|
||||
git quick-push
|
||||
EOF
|
||||
|
||||
print_success "Fichier de configuration créé: .ssh-config"
|
||||
|
||||
# 8. Résumé de la configuration
|
||||
echo ""
|
||||
print_success "=== Configuration SSH terminée ==="
|
||||
echo ""
|
||||
echo "✅ Configuration Git pour SSH"
|
||||
echo "✅ Alias Git configurés"
|
||||
echo "✅ Remotes vérifiés"
|
||||
echo "✅ Scripts configurés"
|
||||
echo ""
|
||||
|
||||
if [[ "$SSH_WORKING" == "true" ]]; then
|
||||
print_success "SSH fonctionne correctement"
|
||||
echo ""
|
||||
echo "🚀 Vous pouvez maintenant utiliser :"
|
||||
echo " ./scripts/auto-ssh-push.sh quick"
|
||||
echo " ./scripts/auto-ssh-push.sh message \"Mon message\""
|
||||
echo " git ssh-push \"Mon message\""
|
||||
echo " git quick-push"
|
||||
echo ""
|
||||
else
|
||||
print_warning "SSH ne fonctionne pas encore"
|
||||
echo ""
|
||||
echo "🔧 Pour configurer SSH :"
|
||||
echo " 1. Générer une clé SSH : ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk"
|
||||
echo " 2. Ajouter à l'agent SSH : ssh-add ~/.ssh/id_ed25519_4nk"
|
||||
echo " 3. Ajouter la clé publique à votre compte Gitea"
|
||||
echo " 4. Relancer ce script : ./scripts/init-ssh-env.sh"
|
||||
echo ""
|
||||
fi
|
||||
|
||||
# 9. Test final
|
||||
if [[ "$SSH_WORKING" == "true" ]]; then
|
||||
print_status "Test final de push SSH..."
|
||||
echo "💡 Pour tester, utilisez : ./scripts/auto-ssh-push.sh status"
|
||||
fi
|
||||
|
||||
print_success "Initialisation SSH terminée !"
|
||||
@ -1,79 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Script de configuration SSH pour CI/CD ihm_client
|
||||
# Utilise automatiquement la clé SSH pour les opérations Git
|
||||
|
||||
set -e
|
||||
|
||||
echo "🔑 Configuration automatique de la clé SSH pour ihm_client CI/CD..."
|
||||
|
||||
# Vérifier si on est dans un environnement CI
|
||||
if [ -n "$CI" ]; then
|
||||
echo "✅ Environnement CI détecté"
|
||||
|
||||
# Configuration SSH pour Gitea Actions
|
||||
if [ -n "$SSH_PRIVATE_KEY" ]; then
|
||||
echo "🔐 Configuration de la clé SSH privée..."
|
||||
|
||||
# Créer le répertoire SSH
|
||||
mkdir -p ~/.ssh
|
||||
chmod 700 ~/.ssh
|
||||
|
||||
# Écrire la clé privée
|
||||
echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
|
||||
# Ajouter la clé publique correspondante (si disponible)
|
||||
if [ -n "$SSH_PUBLIC_KEY" ]; then
|
||||
echo "$SSH_PUBLIC_KEY" > ~/.ssh/id_rsa.pub
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
fi
|
||||
|
||||
# Configuration SSH pour git.4nkweb.com
|
||||
cat > ~/.ssh/config << EOF
|
||||
Host git.4nkweb.com
|
||||
HostName git.4nkweb.com
|
||||
User git
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
StrictHostKeyChecking no
|
||||
UserKnownHostsFile=/dev/null
|
||||
EOF
|
||||
|
||||
chmod 600 ~/.ssh/config
|
||||
|
||||
# Tester la connexion SSH
|
||||
echo "🧪 Test de connexion SSH vers git.4nkweb.com..."
|
||||
if ssh -T git@git.4nkweb.com 2>&1 | grep -q "Welcome"; then
|
||||
echo "✅ Connexion SSH réussie"
|
||||
else
|
||||
echo "⚠️ Connexion SSH établie (message de bienvenue non détecté)"
|
||||
fi
|
||||
|
||||
# Configurer Git pour utiliser SSH
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
|
||||
echo "✅ Configuration SSH terminée"
|
||||
else
|
||||
echo "⚠️ Variable SSH_PRIVATE_KEY non définie, utilisation de HTTPS"
|
||||
fi
|
||||
else
|
||||
echo "ℹ️ Environnement local détecté"
|
||||
|
||||
# Vérifier si une clé SSH existe
|
||||
if [ -f ~/.ssh/id_rsa ]; then
|
||||
echo "🔑 Clé SSH locale trouvée"
|
||||
|
||||
# Configurer Git pour utiliser SSH localement
|
||||
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
|
||||
|
||||
echo "✅ Configuration SSH locale terminée"
|
||||
else
|
||||
echo "⚠️ Aucune clé SSH trouvée, configuration manuelle requise"
|
||||
echo "💡 Pour configurer SSH manuellement :"
|
||||
echo " 1. Générer une clé SSH : ssh-keygen -t rsa -b 4096"
|
||||
echo " 2. Ajouter la clé publique à votre compte Gitea"
|
||||
echo " 3. Tester : ssh -T git@git.4nkweb.com"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "🎯 Configuration SSH terminée pour ihm_client"
|
||||
@ -1,69 +0,0 @@
|
||||
use anyhow::Result;
|
||||
use rs_merkle::{algorithms::Sha256, MerkleProof};
|
||||
use sp_client::silentpayments::{
|
||||
bitcoin_hashes::{sha256t_hash_newtype, Hash, HashEngine},
|
||||
secp256k1::PublicKey,
|
||||
};
|
||||
|
||||
use aes_gcm::aead::{Aead, Payload};
|
||||
pub use aes_gcm::{AeadCore, Aes256Gcm, KeyInit};
|
||||
use rand::{thread_rng, CryptoRng, RngCore};
|
||||
|
||||
pub const AAD: &[u8] = "4nk".as_bytes();
|
||||
|
||||
sha256t_hash_newtype! {
|
||||
pub struct AnkSharedSecretTag = hash_str("4nk/AnkSharedSecret");
|
||||
|
||||
#[hash_newtype(forward)]
|
||||
pub struct AnkSharedSecretHash(_);
|
||||
}
|
||||
|
||||
impl AnkSharedSecretHash {
|
||||
pub fn from_shared_point(shared_point: PublicKey) -> Self {
|
||||
let mut eng = AnkSharedSecretHash::engine();
|
||||
eng.input(&shared_point.serialize_uncompressed()[1..]);
|
||||
AnkSharedSecretHash::from_engine(eng)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn generate_key(rng: &mut (impl CryptoRng + RngCore)) -> [u8; 32] {
|
||||
let key = Aes256Gcm::generate_key(rng);
|
||||
key.into()
|
||||
}
|
||||
|
||||
pub fn encrypt_with_key(key: &[u8; 32], plaintext: &[u8]) -> Result<Vec<u8>> {
|
||||
let encryption_eng = Aes256Gcm::new(key.into());
|
||||
let nonce = Aes256Gcm::generate_nonce(&mut thread_rng());
|
||||
let payload = Payload {
|
||||
msg: plaintext,
|
||||
aad: AAD,
|
||||
};
|
||||
let ciphertext = encryption_eng
|
||||
.encrypt(&nonce, payload)
|
||||
.map_err(|e| anyhow::anyhow!(e))?;
|
||||
|
||||
let mut res: Vec<u8> = Vec::with_capacity(nonce.len() + ciphertext.len());
|
||||
res.extend_from_slice(&nonce);
|
||||
res.extend_from_slice(&ciphertext);
|
||||
|
||||
Ok(res)
|
||||
}
|
||||
|
||||
pub fn decrypt_with_key(key: &[u8; 32], ciphertext: &[u8]) -> Result<Vec<u8>> {
|
||||
let decryption_eng = Aes256Gcm::new(key.into());
|
||||
let nonce = &ciphertext[..12];
|
||||
let payload = Payload {
|
||||
msg: &ciphertext[12..],
|
||||
aad: AAD,
|
||||
};
|
||||
let plaintext = decryption_eng
|
||||
.decrypt(nonce.into(), payload)
|
||||
.map_err(|e| anyhow::anyhow!(e))?;
|
||||
|
||||
Ok(plaintext)
|
||||
}
|
||||
|
||||
pub fn verify_merkle_proof(proof: &[u8], root: &[u8; 32], index: usize, hash: &[u8; 32], total_leaves_count: usize) -> Result<bool> {
|
||||
let proof = MerkleProof::<Sha256>::from_bytes(proof)?;
|
||||
Ok(proof.verify(*root, &[index], &[*hash], total_leaves_count))
|
||||
}
|
||||
181
src/device.rs
181
src/device.rs
@ -1,181 +0,0 @@
|
||||
use std::collections::HashMap;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tsify::Tsify;
|
||||
use wasm_bindgen::prelude::*;
|
||||
|
||||
use sp_client::{
|
||||
bitcoin::{
|
||||
absolute::Height, hashes::Hash, secp256k1::PublicKey, Amount, OutPoint, Transaction,
|
||||
XOnlyPublicKey,
|
||||
},
|
||||
silentpayments::{utils::receiving::calculate_ecdh_shared_secret, SilentPaymentAddress},
|
||||
OutputSpendStatus, OwnedOutput, SpClient,
|
||||
};
|
||||
|
||||
use crate::{pcd::Member, silentpayments::SpWallet};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, Default, Tsify)]
|
||||
#[tsify(into_wasm_abi, from_wasm_abi)]
|
||||
pub struct Device {
|
||||
sp_wallet: SpWallet,
|
||||
pairing_process_commitment: Option<OutPoint>,
|
||||
paired_member: Member,
|
||||
}
|
||||
|
||||
impl Device {
|
||||
pub fn new(sp_client: SpClient) -> Self {
|
||||
let local_address = sp_client.get_receiving_address();
|
||||
let member = Member::new(vec![SilentPaymentAddress::try_from(local_address).unwrap()]);
|
||||
Self {
|
||||
sp_wallet: SpWallet::new(sp_client),
|
||||
pairing_process_commitment: None,
|
||||
paired_member: member,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_sp_wallet(&self) -> &SpWallet {
|
||||
&self.sp_wallet
|
||||
}
|
||||
|
||||
pub fn get_sp_client(&self) -> &SpClient {
|
||||
self.sp_wallet.get_sp_client()
|
||||
}
|
||||
|
||||
pub fn get_outputs(&self) -> &HashMap<OutPoint, OwnedOutput> {
|
||||
self.sp_wallet.get_outputs()
|
||||
}
|
||||
|
||||
pub fn get_mut_outputs(&mut self) -> &mut HashMap<OutPoint, OwnedOutput> {
|
||||
self.sp_wallet.get_mut_outputs()
|
||||
}
|
||||
|
||||
pub fn get_balance(&self) -> Amount {
|
||||
self.sp_wallet
|
||||
.get_outputs()
|
||||
.values()
|
||||
.filter(|output| output.spend_status == OutputSpendStatus::Unspent)
|
||||
.fold(Amount::ZERO, |acc, x| acc + x.amount)
|
||||
}
|
||||
|
||||
pub fn update_outputs_with_transaction(
|
||||
&mut self,
|
||||
tx: &Transaction,
|
||||
blockheight: u32,
|
||||
partial_tweak: PublicKey,
|
||||
) -> anyhow::Result<HashMap<OutPoint, OwnedOutput>> {
|
||||
// First check that we haven't already scanned this transaction
|
||||
let txid = tx.txid();
|
||||
|
||||
for i in 0..tx.output.len() {
|
||||
if self.sp_wallet.get_outputs().contains_key(&OutPoint {
|
||||
txid,
|
||||
vout: i as u32,
|
||||
}) {
|
||||
return Err(anyhow::Error::msg("Transaction already scanned"));
|
||||
}
|
||||
}
|
||||
|
||||
for input in tx.input.iter() {
|
||||
if let Some(output) = self.sp_wallet.get_outputs().get(&input.previous_output) {
|
||||
match &output.spend_status {
|
||||
OutputSpendStatus::Spent(tx) => {
|
||||
if *tx == txid.as_raw_hash().to_byte_array() {
|
||||
return Err(anyhow::Error::msg("Transaction already scanned"));
|
||||
}
|
||||
}
|
||||
OutputSpendStatus::Mined(_) => {
|
||||
return Err(anyhow::Error::msg("Transaction already scanned"))
|
||||
}
|
||||
_ => continue,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let shared_secret = calculate_ecdh_shared_secret(
|
||||
&partial_tweak,
|
||||
&self.sp_wallet.get_sp_client().get_scan_key(),
|
||||
);
|
||||
let mut pubkeys_to_check: HashMap<XOnlyPublicKey, u32> = HashMap::new();
|
||||
for (vout, output) in (0u32..).zip(tx.output.iter()) {
|
||||
if output.script_pubkey.is_p2tr() {
|
||||
let xonly = XOnlyPublicKey::from_slice(&output.script_pubkey.as_bytes()[2..])?;
|
||||
pubkeys_to_check.insert(xonly, vout);
|
||||
}
|
||||
}
|
||||
let ours = self
|
||||
.sp_wallet
|
||||
.get_sp_client()
|
||||
.sp_receiver
|
||||
.scan_transaction(&shared_secret, pubkeys_to_check.keys().cloned().collect())?;
|
||||
let mut new_outputs: HashMap<OutPoint, OwnedOutput> = HashMap::new();
|
||||
for (label, map) in ours.iter() {
|
||||
for (key, scalar) in map {
|
||||
let vout = pubkeys_to_check.get(&key).unwrap().to_owned();
|
||||
let txout = tx.output.get(vout as usize).unwrap();
|
||||
|
||||
let outpoint = OutPoint::new(tx.txid(), vout);
|
||||
let owned = OwnedOutput {
|
||||
blockheight: Height::from_consensus(blockheight)?,
|
||||
tweak: scalar.to_be_bytes(),
|
||||
amount: txout.value,
|
||||
script: txout.script_pubkey.to_bytes().try_into()?,
|
||||
label: label.clone(),
|
||||
spend_status: OutputSpendStatus::Unspent,
|
||||
};
|
||||
new_outputs.insert(outpoint, owned);
|
||||
}
|
||||
}
|
||||
let mut res = new_outputs.clone();
|
||||
self.sp_wallet.get_mut_outputs().extend(new_outputs);
|
||||
|
||||
let txid = tx.txid();
|
||||
// update outputs that we own and that are spent
|
||||
for input in tx.input.iter() {
|
||||
if let Some(prevout) = self
|
||||
.sp_wallet
|
||||
.get_mut_outputs()
|
||||
.get_mut(&input.previous_output)
|
||||
{
|
||||
// This is spent by this tx
|
||||
prevout.spend_status = OutputSpendStatus::Spent(*txid.as_byte_array());
|
||||
res.insert(input.previous_output, prevout.clone());
|
||||
}
|
||||
}
|
||||
|
||||
Ok(res)
|
||||
}
|
||||
|
||||
pub fn get_pairing_commitment(&self) -> Option<OutPoint> {
|
||||
self.pairing_process_commitment.clone()
|
||||
}
|
||||
|
||||
pub fn pair(&mut self, commitment_outpoint: OutPoint, member: Member) {
|
||||
self.pairing_process_commitment = Some(commitment_outpoint);
|
||||
self.paired_member = member;
|
||||
}
|
||||
|
||||
pub fn unpair(&mut self) {
|
||||
let local_address = self.get_sp_client().get_receiving_address();
|
||||
let member = Member::new(vec![SilentPaymentAddress::try_from(local_address).unwrap()]);
|
||||
self.paired_member = member;
|
||||
self.pairing_process_commitment = None;
|
||||
}
|
||||
|
||||
pub fn to_member(&self) -> Member {
|
||||
self.paired_member.clone()
|
||||
}
|
||||
|
||||
pub fn get_address(&self) -> SilentPaymentAddress {
|
||||
self.get_sp_client().get_receiving_address()
|
||||
}
|
||||
|
||||
pub fn get_other_addresses(&self) -> Vec<String> {
|
||||
let our_address: String = self.get_sp_client().get_receiving_address().into();
|
||||
self.to_member()
|
||||
.get_addresses()
|
||||
.into_iter()
|
||||
.filter(|a| *a != our_address)
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
41
src/error.rs
41
src/error.rs
@ -1,41 +0,0 @@
|
||||
use std::error::Error;
|
||||
use std::fmt;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
|
||||
pub enum AnkError {
|
||||
GenericError(String),
|
||||
FaucetError(String),
|
||||
NewTxError(String),
|
||||
CipherError(String),
|
||||
}
|
||||
|
||||
impl fmt::Display for AnkError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match self {
|
||||
AnkError::GenericError(msg) => write!(f, "GenericError: {}", msg),
|
||||
AnkError::FaucetError(msg) => write!(f, "FaucetError: {}", msg),
|
||||
AnkError::NewTxError(msg) => write!(f, "NewTxError: {}", msg),
|
||||
AnkError::CipherError(msg) => write!(f, "CipherError: {}", msg),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Error for AnkError {}
|
||||
|
||||
impl From<anyhow::Error> for AnkError {
|
||||
fn from(error: anyhow::Error) -> Self {
|
||||
let error_message = error.to_string();
|
||||
|
||||
if error_message.contains("FaucetError") {
|
||||
AnkError::FaucetError(error_message)
|
||||
} else if error_message.contains("NewTxError") {
|
||||
AnkError::NewTxError(error_message)
|
||||
} else if error_message.contains("CipherError") {
|
||||
AnkError::CipherError(error_message)
|
||||
} else {
|
||||
AnkError::GenericError(error_message)
|
||||
}
|
||||
}
|
||||
}
|
||||
24
src/hash.rs
24
src/hash.rs
@ -1,24 +0,0 @@
|
||||
use sp_client::bitcoin::{
|
||||
consensus::{serialize, Encodable},
|
||||
hashes::{sha256t_hash_newtype, Hash, HashEngine},
|
||||
OutPoint,
|
||||
};
|
||||
|
||||
sha256t_hash_newtype! {
|
||||
pub struct AnkPcdTag = hash_str("4nk/Pcd");
|
||||
|
||||
#[hash_newtype(forward)]
|
||||
pub struct AnkPcdHash(_);
|
||||
}
|
||||
|
||||
impl AnkPcdHash {
|
||||
pub fn from_pcd_value(value: &[u8], label: &[u8], outpoint: &OutPoint) -> Self {
|
||||
let mut eng = AnkPcdHash::engine();
|
||||
eng.input(value);
|
||||
eng.input(label);
|
||||
serialize(outpoint)
|
||||
.consensus_encode(&mut eng)
|
||||
.expect("hash engine don't return errors");
|
||||
AnkPcdHash::from_engine(eng)
|
||||
}
|
||||
}
|
||||
132
src/lib.rs
132
src/lib.rs
@ -1,129 +1,3 @@
|
||||
use std::fmt::Debug;
|
||||
use std::str::FromStr;
|
||||
use std::sync::{Mutex, MutexGuard};
|
||||
|
||||
pub use aes_gcm;
|
||||
pub use env_logger;
|
||||
pub use log;
|
||||
pub use rand;
|
||||
pub use serde;
|
||||
pub use serde_json;
|
||||
pub use sp_client;
|
||||
pub use tsify;
|
||||
pub use wasm_bindgen;
|
||||
pub use zstd;
|
||||
|
||||
#[cfg(feature = "blindbit-wasm")]
|
||||
pub use js_sys;
|
||||
#[cfg(feature = "blindbit-wasm")]
|
||||
pub use serde_wasm_bindgen;
|
||||
|
||||
#[cfg(feature = "blindbit-backend")]
|
||||
pub use backend_blindbit_native;
|
||||
|
||||
pub mod crypto;
|
||||
pub mod device;
|
||||
pub mod error;
|
||||
pub mod hash;
|
||||
pub mod network;
|
||||
pub mod pcd;
|
||||
pub mod prd;
|
||||
pub mod process;
|
||||
pub mod secrets;
|
||||
pub mod serialization;
|
||||
pub mod signature;
|
||||
pub mod silentpayments;
|
||||
pub mod updates;
|
||||
|
||||
pub const MAX_PRD_PAYLOAD_SIZE: usize = u16::MAX as usize; // 64KiB sounds reasonable for now
|
||||
|
||||
const DEMIURGE: &str = "demiurge";
|
||||
const PAIRING: &str = "pairing";
|
||||
const APOPHIS: &str = "apophis";
|
||||
|
||||
const MEMBERPUBLICNAME: &str = "memberPublicName";
|
||||
const PAIREDADDRESSES: &str = "pairedAddresses";
|
||||
|
||||
const ROLESLABEL: &str = "roles";
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub enum SpecialRoles {
|
||||
Demiurge, // Only valid for the first state of a process
|
||||
Pairing, // Special validation rules for pairing process
|
||||
Apophis, // Users in this role have the power to destroy the process
|
||||
}
|
||||
|
||||
impl std::fmt::Display for SpecialRoles {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "{}", <&Self as Into<&str>>::into(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl From<&SpecialRoles> for &str {
|
||||
fn from(value: &SpecialRoles) -> Self {
|
||||
match value {
|
||||
SpecialRoles::Demiurge => DEMIURGE,
|
||||
SpecialRoles::Pairing => PAIRING,
|
||||
SpecialRoles::Apophis => APOPHIS,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl FromStr for SpecialRoles {
|
||||
type Err = String;
|
||||
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
match s {
|
||||
DEMIURGE => Ok(SpecialRoles::Demiurge),
|
||||
PAIRING => Ok(SpecialRoles::Pairing),
|
||||
APOPHIS => Ok(SpecialRoles::Apophis),
|
||||
_ => Err(format!("Invalid special role: {}", s)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub enum ReservedFields {
|
||||
PairedAddresses,
|
||||
MemberPublicName,
|
||||
}
|
||||
|
||||
impl From<&ReservedFields> for &str {
|
||||
fn from(value: &ReservedFields) -> Self {
|
||||
match value {
|
||||
ReservedFields::MemberPublicName => MEMBERPUBLICNAME,
|
||||
ReservedFields::PairedAddresses => PAIREDADDRESSES,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl FromStr for ReservedFields {
|
||||
type Err = String;
|
||||
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
match s {
|
||||
MEMBERPUBLICNAME => Ok(ReservedFields::MemberPublicName),
|
||||
PAIREDADDRESSES => Ok(ReservedFields::PairedAddresses),
|
||||
_ => Err(format!("Invalid field name: {}", s)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub trait MutexExt<T> {
|
||||
fn lock_anyhow(&self) -> Result<MutexGuard<T>, anyhow::Error>;
|
||||
}
|
||||
|
||||
impl<T: Debug> MutexExt<T> for Mutex<T> {
|
||||
fn lock_anyhow(&self) -> Result<MutexGuard<T>, anyhow::Error> {
|
||||
match self.lock() {
|
||||
Ok(guard) => Ok(guard),
|
||||
Err(poison_error) => {
|
||||
let data = poison_error.into_inner();
|
||||
|
||||
log::debug!("Failed to lock Mutex (poisoned). Data was: {:?}", data);
|
||||
|
||||
Err(anyhow::anyhow!("Failed to lock Mutex (poisoned)"))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
pub mod models;
|
||||
pub mod wallet;
|
||||
pub mod workflows;
|
||||
|
||||
5
src/main.rs
Normal file
5
src/main.rs
Normal file
@ -0,0 +1,5 @@
|
||||
use sdk_common::models;
|
||||
use sdk_common::wallet;
|
||||
use sdk_common::workflows;
|
||||
|
||||
fn main() {}
|
||||
11
src/models/commitment_method.rs
Normal file
11
src/models/commitment_method.rs
Normal file
@ -0,0 +1,11 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct commitMethod {
|
||||
pub method: String,
|
||||
}
|
||||
impl commitMethod {
|
||||
pub fn new(method: String) -> Self {
|
||||
commitMethod { method }
|
||||
}
|
||||
}
|
||||
25
src/models/condition_cap.rs
Normal file
25
src/models/condition_cap.rs
Normal file
@ -0,0 +1,25 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::role::TransactionMode;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct ConditionCap {
|
||||
pub role_deposit: String,
|
||||
pub role_transaction: TransactionMode,
|
||||
}
|
||||
|
||||
impl ConditionCap {
|
||||
pub fn new(role_deposit: String, role_transaction: TransactionMode) -> Self {
|
||||
ConditionCap {
|
||||
role_deposit,
|
||||
role_transaction,
|
||||
}
|
||||
}
|
||||
// Affiche les informations de la structure
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionCap:");
|
||||
println!("Role Deposit: {}", self.role_deposit);
|
||||
println!("Role Transaction:");
|
||||
self.role_transaction.display_info(); // Appelle display_info sur role_transaction
|
||||
}
|
||||
}
|
||||
23
src/models/condition_commitment.rs
Normal file
23
src/models/condition_commitment.rs
Normal file
@ -0,0 +1,23 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::role::TransactionMode;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct Conditioncommit {
|
||||
pub role_artefact: String,
|
||||
pub role_transaction: TransactionMode,
|
||||
}
|
||||
|
||||
impl Conditioncommit {
|
||||
pub fn new(role_artefact: String, role_transaction: TransactionMode) -> Self {
|
||||
Conditioncommit {
|
||||
role_artefact,
|
||||
role_transaction,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Conditioncommit:");
|
||||
println!("Role Artefact: {}", self.role_artefact);
|
||||
println!("Role Transaction:");
|
||||
self.role_transaction.display_info(); // Appelle display_info sur role_transaction
|
||||
}
|
||||
}
|
||||
24
src/models/condition_deposit.rs
Normal file
24
src/models/condition_deposit.rs
Normal file
@ -0,0 +1,24 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::role::TransactionMode;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ConditionDeposit {
|
||||
pub role_deposit: String,
|
||||
pub role_transaction: TransactionMode,
|
||||
}
|
||||
|
||||
impl ConditionDeposit {
|
||||
pub fn new(role_deposit: String, role_transaction: TransactionMode) -> Self {
|
||||
ConditionDeposit {
|
||||
role_deposit,
|
||||
role_transaction,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionDeposit:");
|
||||
println!("Role Deposit: {}", self.role_deposit);
|
||||
println!("Role Transaction:");
|
||||
self.role_transaction.display_info(); // Appelle display_info sur role_transaction
|
||||
}
|
||||
}
|
||||
19
src/models/condition_orchestration.rs
Normal file
19
src/models/condition_orchestration.rs
Normal file
@ -0,0 +1,19 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ConditionOrchestration {
|
||||
pub role_ok: String,
|
||||
pub role_ko: String,
|
||||
}
|
||||
|
||||
impl ConditionOrchestration {
|
||||
pub fn new(role_ok: String, role_ko: String) -> Self {
|
||||
ConditionOrchestration { role_ok, role_ko }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionOrchestration:");
|
||||
println!("Role OK: {}", self.role_ok);
|
||||
println!("Role KO: {}", self.role_ko);
|
||||
}
|
||||
}
|
||||
25
src/models/condition_payment.rs
Normal file
25
src/models/condition_payment.rs
Normal file
@ -0,0 +1,25 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::role::TransactionMode;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ConditionPayments {
|
||||
pub role_Payments: String,
|
||||
pub role_transaction: TransactionMode,
|
||||
}
|
||||
|
||||
impl ConditionPayments {
|
||||
pub fn new(role_Payments: String, role_transaction: TransactionMode) -> Self {
|
||||
ConditionPayments {
|
||||
role_Payments,
|
||||
role_transaction,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionPayments:");
|
||||
println!("Role Payments: {}", self.role_Payments);
|
||||
println!("Role Transaction:");
|
||||
self.role_transaction.display_info(); // Appelle display_info sur role_transaction
|
||||
}
|
||||
}
|
||||
141
src/models/condition_prd_address_set.rs
Normal file
141
src/models/condition_prd_address_set.rs
Normal file
@ -0,0 +1,141 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ConditionPrdAddressSet {
|
||||
pub from_role: String,
|
||||
pub prd_sp_address_list: Vec<String>,
|
||||
pub prd_sp_address_required_list: Vec<String>,
|
||||
pub prd_sp_address_quota: i32,
|
||||
pub prd_prd_value_ok_list: Vec<String>,
|
||||
pub prd_value_ko_list: Vec<String>,
|
||||
pub prd_value_none_list: Vec<String>,
|
||||
pub prd_sp_address_value_min: i64,
|
||||
pub prd_sp_address_value_min_per: i64,
|
||||
pub prd_sp_address_value_min_ok: bool,
|
||||
pub prd_sp_adddress_value_ok_min_per: i64,
|
||||
pub prd_sp_address_value_ok_max: i64,
|
||||
pub prd_sp_adderss_value_ko_max_per: i64,
|
||||
pub prd_sp_address_value_none_max: i64,
|
||||
pub prd_sp_adderss_value_none_max_per: i64,
|
||||
pub prd_sp_address_score_min: i32,
|
||||
pub prd_sp_address_score_min_min_required: i32,
|
||||
pub prd_sp_address_score_min_min_ok: bool,
|
||||
pub prd_sp_address_score_min_min_per: i64,
|
||||
pub prd_value_auto_ok: bool,
|
||||
pub prd_value_auto_ko: bool,
|
||||
pub prd_value_auto_none: bool,
|
||||
}
|
||||
|
||||
impl ConditionPrdAddressSet {
|
||||
// Constructor for PrdAddressSet with all fields
|
||||
pub fn new(
|
||||
from_role: String,
|
||||
prd_sp_address_list: Vec<String>,
|
||||
prd_sp_address_required_list: Vec<String>,
|
||||
prd_sp_address_quota: i32,
|
||||
prd_prd_value_ok_list: Vec<String>,
|
||||
prd_value_ko_list: Vec<String>,
|
||||
prd_value_none_list: Vec<String>,
|
||||
prd_sp_address_value_min: i64,
|
||||
prd_sp_address_value_min_per: i64,
|
||||
prd_sp_address_value_min_ok: bool,
|
||||
prd_sp_adddress_value_ok_min_per: i64,
|
||||
prd_sp_address_value_ok_max: i64,
|
||||
prd_sp_adderss_value_ko_max_per: i64,
|
||||
prd_sp_address_value_none_max: i64,
|
||||
prd_sp_adderss_value_none_max_per: i64,
|
||||
prd_sp_address_score_min: i32,
|
||||
prd_sp_address_score_min_min_required: i32,
|
||||
prd_sp_address_score_min_min_ok: bool,
|
||||
prd_sp_address_score_min_min_per: i64,
|
||||
prd_value_auto_ok: bool,
|
||||
prd_value_auto_ko: bool,
|
||||
prd_value_auto_none: bool,
|
||||
) -> Self {
|
||||
ConditionPrdAddressSet {
|
||||
from_role,
|
||||
prd_sp_address_list,
|
||||
prd_sp_address_required_list,
|
||||
prd_sp_address_quota,
|
||||
prd_prd_value_ok_list,
|
||||
prd_value_ko_list,
|
||||
prd_value_none_list,
|
||||
prd_sp_address_value_min,
|
||||
prd_sp_address_value_min_per,
|
||||
prd_sp_address_value_min_ok,
|
||||
prd_sp_adddress_value_ok_min_per,
|
||||
prd_sp_address_value_ok_max,
|
||||
prd_sp_adderss_value_ko_max_per,
|
||||
prd_sp_address_value_none_max,
|
||||
prd_sp_adderss_value_none_max_per,
|
||||
prd_sp_address_score_min,
|
||||
prd_sp_address_score_min_min_required,
|
||||
prd_sp_address_score_min_min_ok,
|
||||
prd_sp_address_score_min_min_per,
|
||||
prd_value_auto_ok,
|
||||
prd_value_auto_ko,
|
||||
prd_value_auto_none,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionPrdAddressSet:");
|
||||
println!("From Role: {}", self.from_role);
|
||||
println!("SP Address List: {:?}", self.prd_sp_address_list);
|
||||
println!(
|
||||
"SP Address Required List: {:?}",
|
||||
self.prd_sp_address_required_list
|
||||
);
|
||||
println!("SP Address Quota: {}", self.prd_sp_address_quota);
|
||||
println!("PRD Value OK List: {:?}", self.prd_prd_value_ok_list);
|
||||
println!("Value KO List: {:?}", self.prd_value_ko_list);
|
||||
println!("Value None List: {:?}", self.prd_value_none_list);
|
||||
println!("SP Address Value Min: {}", self.prd_sp_address_value_min);
|
||||
println!(
|
||||
"SP Address Value Min Percentage: {}",
|
||||
self.prd_sp_address_value_min_per
|
||||
);
|
||||
println!(
|
||||
"SP Address Value Min OK: {}",
|
||||
self.prd_sp_address_value_min_ok
|
||||
);
|
||||
println!(
|
||||
"SP Address Value OK Min Percentage: {}",
|
||||
self.prd_sp_adddress_value_ok_min_per
|
||||
);
|
||||
println!(
|
||||
"SP Address Value OK Max: {}",
|
||||
self.prd_sp_address_value_ok_max
|
||||
);
|
||||
println!(
|
||||
"SP Address Value KO Max Percentage: {}",
|
||||
self.prd_sp_adderss_value_ko_max_per
|
||||
);
|
||||
println!(
|
||||
"SP Address Value None Max: {}",
|
||||
self.prd_sp_address_value_none_max
|
||||
);
|
||||
println!(
|
||||
"SP Address Value None Max Percentage: {}",
|
||||
self.prd_sp_adderss_value_none_max_per
|
||||
);
|
||||
println!("SP Address Score Min: {}", self.prd_sp_address_score_min);
|
||||
println!(
|
||||
"SP Address Score Min Required: {}",
|
||||
self.prd_sp_address_score_min_min_required
|
||||
);
|
||||
println!(
|
||||
"SP Address Score Min OK: {}",
|
||||
self.prd_sp_address_score_min_min_ok
|
||||
);
|
||||
println!(
|
||||
"SP Address Score Min Percentage: {}",
|
||||
self.prd_sp_address_score_min_min_per
|
||||
);
|
||||
println!("Value Auto OK: {}", self.prd_value_auto_ok);
|
||||
println!("Value Auto KO: {}", self.prd_value_auto_ko);
|
||||
println!("Value Auto None: {}", self.prd_value_auto_none);
|
||||
}
|
||||
|
||||
// Methods for manipulating the struct can be added here as needed.
|
||||
}
|
||||
49
src/models/condition_publish.rs
Normal file
49
src/models/condition_publish.rs
Normal file
@ -0,0 +1,49 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::metadata::Amount;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ConditionPublish {
|
||||
pub pcd_data_size_max_unit: String,
|
||||
pub pcd_data_size_max_total: i64,
|
||||
pub pcd_number_min: i32,
|
||||
pub pcd_number_max: i32,
|
||||
pub pcd_amount_max_total: Amount,
|
||||
pub Prd_waiting_timeout: u64,
|
||||
pub pcd_waiting_timeout: u64,
|
||||
}
|
||||
|
||||
impl ConditionPublish {
|
||||
pub fn new(
|
||||
pcd_data_size_max_unit: String,
|
||||
pcd_data_size_max_total: i64,
|
||||
pcd_number_min: i32,
|
||||
pcd_number_max: i32,
|
||||
pcd_amount_max_total: Amount,
|
||||
Prd_waiting_timeout: u64,
|
||||
pcd_waiting_timeout: u64,
|
||||
) -> Self {
|
||||
ConditionPublish {
|
||||
pcd_data_size_max_unit,
|
||||
pcd_data_size_max_total,
|
||||
pcd_number_min,
|
||||
pcd_number_max,
|
||||
pcd_amount_max_total,
|
||||
Prd_waiting_timeout,
|
||||
pcd_waiting_timeout,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ConditionPublish:");
|
||||
println!("PCD Data Size Max Unit: {}", self.pcd_data_size_max_unit);
|
||||
println!("PCD Data Size Max Total: {}", self.pcd_data_size_max_total);
|
||||
println!("PCD Number Min: {}", self.pcd_number_min);
|
||||
println!("PCD Number Max: {}", self.pcd_number_max);
|
||||
self.pcd_amount_max_total.display_info();
|
||||
println!(
|
||||
" Prd Waiting Timeout: {}",
|
||||
self.Prd_waiting_timeout
|
||||
);
|
||||
println!("PCD Waiting Timeout: {}", self.pcd_waiting_timeout);
|
||||
}
|
||||
}
|
||||
8
src/models/deposit_method.rs
Normal file
8
src/models/deposit_method.rs
Normal file
@ -0,0 +1,8 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct DepositMethod {
|
||||
pub method: String,
|
||||
}
|
||||
impl DepositMethod {}
|
||||
94
src/models/item.rs
Normal file
94
src/models/item.rs
Normal file
@ -0,0 +1,94 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use uuid::Uuid;
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, metadata_contract_public::MetadataContractPublic,
|
||||
metadata_private::MetadataPrivate, metadata_role_confidential::MetadataRoleConfidential,
|
||||
pcd_item_enc::PcdItemEnc,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Item {
|
||||
pub uuid: String,
|
||||
pub version: i64,
|
||||
pub hash: Option<String>,
|
||||
pub item_type: String, // `type` is a reserved keyword in Rust, renamed to `item_type`
|
||||
pub name: String,
|
||||
pub pagination_number_per_pcd: u32,
|
||||
pub metadata_contract_public: MetadataContractPublic,
|
||||
pub metadata_role_confidential: MetadataRoleConfidential,
|
||||
pub metadata_private: MetadataPrivate,
|
||||
}
|
||||
|
||||
impl Item {
|
||||
pub fn new(
|
||||
version: i64,
|
||||
item_type: String,
|
||||
name: String,
|
||||
pagination_number_per_pcd: u32,
|
||||
metadata_contract_public: MetadataContractPublic,
|
||||
metadata_role_confidential: MetadataRoleConfidential,
|
||||
metadata_private: MetadataPrivate,
|
||||
) -> Self {
|
||||
let uuid: String = Uuid::new_v4().to_string();
|
||||
Item {
|
||||
uuid,
|
||||
version,
|
||||
item_type,
|
||||
name,
|
||||
pagination_number_per_pcd,
|
||||
metadata_contract_public,
|
||||
metadata_role_confidential,
|
||||
metadata_private,
|
||||
hash: None,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Item:");
|
||||
println!("UUID: {}", self.uuid);
|
||||
println!("Version: {}", self.version);
|
||||
println!("Item Type: {}", self.item_type);
|
||||
println!("Name: {}", self.name);
|
||||
println!(
|
||||
"Pagination Number Per PCD: {}",
|
||||
self.pagination_number_per_pcd
|
||||
);
|
||||
|
||||
println!("Metadata Contract Public:");
|
||||
self.metadata_contract_public.display_info(); // Display information for `metadata_contract_public`
|
||||
|
||||
println!("Metadata Role Confidential:");
|
||||
self.metadata_role_confidential.display_info(); // Display information for `metadata_role_confidential`
|
||||
|
||||
println!("Metadata Private:");
|
||||
self.metadata_private.display_info(); // Display information for `metadata_private`
|
||||
}
|
||||
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.metadata_contract_public
|
||||
.enc_list(process_public_enc_key);
|
||||
|
||||
let enc_metadata_role_confidential = self.metadata_role_confidential.enc_list();
|
||||
|
||||
let enc_metadata_private = self.metadata_private.enc_list(Member_private_enc_key);
|
||||
|
||||
PcdItemEnc::new(
|
||||
self.version,
|
||||
self.item_type.clone(),
|
||||
self.name.clone(),
|
||||
self.pagination_number_per_pcd,
|
||||
enc_metadata_contract_public,
|
||||
enc_metadata_role_confidential,
|
||||
enc_metadata_private,
|
||||
)
|
||||
}
|
||||
|
||||
// Additional methods for Item can be added here
|
||||
}
|
||||
131
src/models/item_artefact.rs
Normal file
131
src/models/item_artefact.rs
Normal file
@ -0,0 +1,131 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::json;
|
||||
use std::hash::Hash;
|
||||
|
||||
use super::item::Item;
|
||||
use super::key_encryption::KeyEncryption;
|
||||
use super::pcd_item_enc_attribute_private::PcdItemEncAttributePrivate;
|
||||
use super::pcd_item_enc_attribute_public::PcdItemEncAttributePublic;
|
||||
use super::pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential;
|
||||
use super::pcd_item_generic_enc::PcdItemGenericEnc;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct Artefact {
|
||||
pub item: Item,
|
||||
pub public_attribute_group: Vec<String>, // Assuming list of attributes
|
||||
pub role_confidential_attribute_group: Vec<String>,
|
||||
pub private_attribute_group: Vec<String>,
|
||||
}
|
||||
|
||||
impl Artefact {
|
||||
pub fn new(
|
||||
item: Item,
|
||||
public_attribute_group: Vec<String>,
|
||||
role_confidential_attribute_group: Vec<String>,
|
||||
private_attribute_group: Vec<String>,
|
||||
) -> Self {
|
||||
Artefact {
|
||||
item,
|
||||
public_attribute_group,
|
||||
role_confidential_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc_public_attribute_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let mut count = 0;
|
||||
for public_attribute in &self.public_attribute_group {
|
||||
let name = "index".to_owned() + &count.to_string();
|
||||
let value = serde_json::to_value(public_attribute).unwrap_or_else(|_| json!({}));
|
||||
let enc_attribute =
|
||||
PcdItemEncAttributePublic::new(name, process_public_enc_key.enc(value));
|
||||
enc_attribute_list.push(enc_attribute);
|
||||
count += 1;
|
||||
}
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn enc_role_confidential_attribute_group(
|
||||
&self,
|
||||
) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
let mut count = 0;
|
||||
for role_confidential_attribute in &self.role_confidential_attribute_group {
|
||||
let name = "index".to_owned() + &count.to_string();
|
||||
let value =
|
||||
serde_json::to_value(role_confidential_attribute).unwrap_or_else(|_| json!({}));
|
||||
let mut role_confidential_attribute_key =
|
||||
KeyEncryption::new(Some(name.clone()), None, None);
|
||||
if let Ok(_new) = role_confidential_attribute_key.key_new_random() {
|
||||
let enc_attribute = PcdItemEncAttributeRoleConfidential::new(
|
||||
name,
|
||||
role_confidential_attribute_key.enc(value),
|
||||
role_confidential_attribute_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute);
|
||||
}
|
||||
count += 1;
|
||||
}
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn enc_private_attribute_group(
|
||||
&self,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let mut count = 0;
|
||||
for private_attribute in &self.public_attribute_group {
|
||||
let name = "index".to_owned() + &count.to_string();
|
||||
let value = serde_json::to_value(private_attribute).unwrap_or_else(|_| json!({}));
|
||||
let enc_attribute =
|
||||
PcdItemEncAttributePrivate::new(name, Member_private_enc_key.enc(value));
|
||||
enc_attribute_list.push(enc_attribute);
|
||||
count += 1;
|
||||
}
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public =
|
||||
self.enc_public_attribute_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_role_confidential_attribute_group = self.enc_role_confidential_attribute_group();
|
||||
|
||||
let enc_metadata_private = self.enc_private_attribute_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
Some(enc_role_confidential_attribute_group),
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Artefact:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Appelle display_info sur item
|
||||
|
||||
println!("Public Attribute Group: {:?}", self.public_attribute_group);
|
||||
println!(
|
||||
"Role Confidential Attribute Group: {:?}",
|
||||
self.role_confidential_attribute_group
|
||||
);
|
||||
println!(
|
||||
"Private Attribute Group: {:?}",
|
||||
self.private_attribute_group
|
||||
);
|
||||
}
|
||||
}
|
||||
239
src/models/item_commitment.rs
Normal file
239
src/models/item_commitment.rs
Normal file
@ -0,0 +1,239 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct CommitPublicAttributeGroup {
|
||||
pub for_sp_address_list: Vec<String>,
|
||||
pub goal_list: Vec<String>,
|
||||
pub provider_type: String,
|
||||
pub commit_pcd_hash_list: Vec<String>,
|
||||
pub ref_item_hash_list: Vec<String>,
|
||||
pub ref_pcd_hash_list: Vec<String>,
|
||||
pub payload_public_list: Vec<String>,
|
||||
}
|
||||
|
||||
impl CommitPublicAttributeGroup {
|
||||
pub fn new(
|
||||
for_sp_address_list: Vec<String>,
|
||||
goal_list: Vec<String>,
|
||||
provider_type: String,
|
||||
commit_pcd_hash_list: Vec<String>,
|
||||
ref_item_hash_list: Vec<String>,
|
||||
ref_pcd_hash_list: Vec<String>,
|
||||
payload_public_list: Vec<String>,
|
||||
) -> Self {
|
||||
CommitPublicAttributeGroup {
|
||||
for_sp_address_list,
|
||||
goal_list,
|
||||
provider_type,
|
||||
commit_pcd_hash_list,
|
||||
ref_item_hash_list,
|
||||
ref_pcd_hash_list,
|
||||
payload_public_list,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let for_sp_address_list_enc = PcdItemEncAttributePublic::new(
|
||||
"for_sp_address_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.for_sp_address_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(for_sp_address_list_enc);
|
||||
|
||||
let goal_list_enc = PcdItemEncAttributePublic::new(
|
||||
"goal_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.goal_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(goal_list_enc);
|
||||
|
||||
let provider_type_enc = PcdItemEncAttributePublic::new(
|
||||
"provider_type".to_owned(),
|
||||
process_public_enc_key.enc_string(self.provider_type.clone()),
|
||||
);
|
||||
enc_attribute_list.push(provider_type_enc);
|
||||
|
||||
let commit_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"commit_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.commit_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(commit_pcd_hash_list_enc);
|
||||
|
||||
let ref_item_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_item_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_item_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_item_hash_list_enc);
|
||||
|
||||
let ref_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_pcd_hash_list_enc);
|
||||
|
||||
let payload_public_list_enc = PcdItemEncAttributePublic::new(
|
||||
"payload_public_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.payload_public_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_public_list_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("CommitPublicAttributeGroup:");
|
||||
println!("For SP Address List: {:?}", self.for_sp_address_list);
|
||||
println!("Goal List: {:?}", self.goal_list);
|
||||
println!("Provider Type: {}", self.provider_type);
|
||||
println!(
|
||||
"commit PCD Hash List: {:?}",
|
||||
self.commit_pcd_hash_list
|
||||
);
|
||||
println!("Ref Item Hash List: {:?}", self.ref_item_hash_list);
|
||||
println!("Ref PCD Hash List: {:?}", self.ref_pcd_hash_list);
|
||||
println!("Payload Public List: {:?}", self.payload_public_list);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct CommitRoleConfidentialAttributeGroup {
|
||||
pub payload_list_confidential: Vec<String>,
|
||||
}
|
||||
|
||||
impl CommitRoleConfidentialAttributeGroup {
|
||||
pub fn new(payload_list_confidential: Vec<String>) -> Self {
|
||||
CommitRoleConfidentialAttributeGroup {
|
||||
payload_list_confidential,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(&self) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
let mut payload_list_confidential_key =
|
||||
KeyEncryption::new(Some("payload_list_confidential".to_owned()), None, None);
|
||||
if let Ok(_new) = payload_list_confidential_key.key_new_random() {
|
||||
let payload_list_confidential_enc = PcdItemEncAttributeRoleConfidential::new(
|
||||
"payload_list_confidential".to_owned(),
|
||||
payload_list_confidential_key
|
||||
.enc_vec_string(self.payload_list_confidential.clone()),
|
||||
payload_list_confidential_key,
|
||||
);
|
||||
enc_attribute_list.push(payload_list_confidential_enc);
|
||||
}
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("CommitRoleConfidentialAttributeGroup:");
|
||||
for (index, payload) in self.payload_list_confidential.iter().enumerate() {
|
||||
println!("Confidential Payload {}: {}", index + 1, payload);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct CommitPrivateAttributeGroup {
|
||||
pub payload_list_private: Vec<String>,
|
||||
}
|
||||
|
||||
impl CommitPrivateAttributeGroup {
|
||||
pub fn new(payload_list_private: Vec<String>) -> Self {
|
||||
CommitPrivateAttributeGroup {
|
||||
payload_list_private,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(&self, Member_enc_key: KeyEncryption) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let payload_list_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"payload_list_private".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.payload_list_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_list_private_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("CommitRoleConfidentialAttributeGroup:");
|
||||
for (index, payload) in self.payload_list_private.iter().enumerate() {
|
||||
println!("Private Payload {}: {}", index + 1, payload);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Commit {
|
||||
pub item: Item,
|
||||
pub public_attribute_group: CommitPublicAttributeGroup,
|
||||
pub role_confidential_attribute_group: CommitRoleConfidentialAttributeGroup,
|
||||
pub private_attribute_group: CommitPrivateAttributeGroup,
|
||||
}
|
||||
|
||||
impl Commit {
|
||||
pub const ITEM_NAME: &'static str = "commit";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
public_attribute_group: CommitPublicAttributeGroup,
|
||||
role_confidential_attribute_group: CommitRoleConfidentialAttributeGroup,
|
||||
private_attribute_group: CommitPrivateAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Commit {
|
||||
item,
|
||||
public_attribute_group,
|
||||
role_confidential_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_role_confidential_attribute_group =
|
||||
self.role_confidential_attribute_group.enc_group();
|
||||
|
||||
let enc_metadata_private = self
|
||||
.private_attribute_group
|
||||
.enc_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
Some(enc_role_confidential_attribute_group),
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Commit:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Affiche les informations de `item`
|
||||
|
||||
println!("Public Attribute Group:");
|
||||
self.public_attribute_group.display_info(); // Affiche les informations de `public_attribute_group`
|
||||
|
||||
println!("Role Confidential Attribute Group:");
|
||||
self.role_confidential_attribute_group.display_info(); // Affiche les informations de `role_confidential_attribute_group`
|
||||
|
||||
println!("Private Attribute Group:");
|
||||
self.private_attribute_group.display_info(); // Affiche les informations de `private_attribute_group`
|
||||
}
|
||||
}
|
||||
277
src/models/item_deposit.rs
Normal file
277
src/models/item_deposit.rs
Normal file
@ -0,0 +1,277 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct DepositPublicAttributeGroup {
|
||||
pub for_sp_address_list: Vec<String>,
|
||||
pub for_address_list: Vec<String>,
|
||||
pub goal_list: Vec<String>,
|
||||
pub provider_type: String,
|
||||
pub ref_item_hash_list: Vec<String>,
|
||||
pub ref_pcd_hash_list: Vec<String>,
|
||||
pub payload_list_public: Vec<String>,
|
||||
pub audit_code_list_public: Vec<String>,
|
||||
}
|
||||
|
||||
impl DepositPublicAttributeGroup {
|
||||
pub fn new(
|
||||
for_sp_address_list: Vec<String>,
|
||||
for_address_list: Vec<String>,
|
||||
goal_list: Vec<String>,
|
||||
provider_type: String,
|
||||
ref_item_hash_list: Vec<String>,
|
||||
ref_pcd_hash_list: Vec<String>,
|
||||
payload_list_public: Vec<String>,
|
||||
audit_code_list_public: Vec<String>,
|
||||
) -> Self {
|
||||
DepositPublicAttributeGroup {
|
||||
for_sp_address_list,
|
||||
for_address_list,
|
||||
goal_list,
|
||||
provider_type,
|
||||
ref_item_hash_list,
|
||||
ref_pcd_hash_list,
|
||||
payload_list_public,
|
||||
audit_code_list_public,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let for_sp_address_list_enc = PcdItemEncAttributePublic::new(
|
||||
"for_sp_address_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.for_sp_address_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(for_sp_address_list_enc);
|
||||
|
||||
let for_address_list_enc = PcdItemEncAttributePublic::new(
|
||||
"for_address_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.for_address_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(for_address_list_enc);
|
||||
|
||||
let goal_list_enc = PcdItemEncAttributePublic::new(
|
||||
"goal_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.goal_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(goal_list_enc);
|
||||
|
||||
let provider_type_enc = PcdItemEncAttributePublic::new(
|
||||
"provider_type".to_owned(),
|
||||
process_public_enc_key.enc_string(self.provider_type.clone()),
|
||||
);
|
||||
enc_attribute_list.push(provider_type_enc);
|
||||
|
||||
let ref_item_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_item_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_item_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_item_hash_list_enc);
|
||||
|
||||
let ref_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_pcd_hash_list_enc);
|
||||
|
||||
let payload_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"payload_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.payload_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_list_public_enc);
|
||||
|
||||
let audit_code_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"audit_code_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.audit_code_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(audit_code_list_public_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("DepositPublicAttributeGroup:");
|
||||
println!("For SP Address List: {:?}", self.for_sp_address_list);
|
||||
println!("For Address List: {:?}", self.for_address_list);
|
||||
println!("Goal List: {:?}", self.goal_list);
|
||||
println!("Provider Type: {}", self.provider_type);
|
||||
println!("Ref Item Hash List: {:?}", self.ref_item_hash_list);
|
||||
println!("Ref PCD Hash List: {:?}", self.ref_pcd_hash_list);
|
||||
println!("Payload List Public: {:?}", self.payload_list_public);
|
||||
println!("Audit Code List Public: {:?}", self.audit_code_list_public);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct DepositRoleConfidentialAttributeGroup {
|
||||
pub payload_list_confidential: Vec<String>,
|
||||
pub audit_code_list_confidential: Vec<String>,
|
||||
}
|
||||
|
||||
impl DepositRoleConfidentialAttributeGroup {
|
||||
pub fn new(
|
||||
payload_list_confidential: Vec<String>,
|
||||
audit_code_list_confidential: Vec<String>,
|
||||
) -> Self {
|
||||
DepositRoleConfidentialAttributeGroup {
|
||||
payload_list_confidential,
|
||||
audit_code_list_confidential,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(&self) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
let mut payload_list_confidential_key =
|
||||
KeyEncryption::new(Some("payload_list_confidential".to_owned()), None, None);
|
||||
|
||||
if let Ok(_new) = payload_list_confidential_key.key_new_random() {
|
||||
let payload_list_confidential_enc = PcdItemEncAttributeRoleConfidential::new(
|
||||
"payload_list_confidential".to_owned(),
|
||||
payload_list_confidential_key
|
||||
.enc_vec_string(self.payload_list_confidential.clone()),
|
||||
payload_list_confidential_key,
|
||||
);
|
||||
enc_attribute_list.push(payload_list_confidential_enc);
|
||||
}
|
||||
|
||||
let mut audit_code_list_confidential_key =
|
||||
KeyEncryption::new(Some("audit_code_list_confidential".to_owned()), None, None);
|
||||
if let Ok(_new) = audit_code_list_confidential_key.key_new_random() {
|
||||
let audit_code_list_confidential_enc = PcdItemEncAttributeRoleConfidential::new(
|
||||
"audit_code_list_confidential".to_owned(),
|
||||
audit_code_list_confidential_key
|
||||
.enc_vec_string(self.audit_code_list_confidential.clone()),
|
||||
audit_code_list_confidential_key,
|
||||
);
|
||||
enc_attribute_list.push(audit_code_list_confidential_enc);
|
||||
}
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("DepositRoleConfidentialAttributeGroup:");
|
||||
println!(
|
||||
"Confidential Payload List: {:?}",
|
||||
self.payload_list_confidential
|
||||
);
|
||||
println!(
|
||||
"Confidential Audit Code List: {:?}",
|
||||
self.audit_code_list_confidential
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct DepositPrivateAttributeGroup {
|
||||
pub payload_list_private: Vec<String>,
|
||||
pub audit_code_private: String,
|
||||
}
|
||||
|
||||
impl DepositPrivateAttributeGroup {
|
||||
pub fn new(payload_list_private: Vec<String>, audit_code_private: String) -> Self {
|
||||
DepositPrivateAttributeGroup {
|
||||
payload_list_private,
|
||||
audit_code_private,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn enc_group(&self, Member_enc_key: KeyEncryption) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let payload_list_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"payload_list_private".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.payload_list_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_list_private_enc);
|
||||
|
||||
let audit_code_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"audit_code_private".to_owned(),
|
||||
Member_enc_key.enc_string(self.audit_code_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(audit_code_private_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("DepositPrivateAttributeGroup:");
|
||||
println!("Private Payload List: {:?}", self.payload_list_private);
|
||||
println!("Private Audit Code: {}", self.audit_code_private);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Deposit {
|
||||
pub item: Item,
|
||||
pub public_attribute_group: DepositPublicAttributeGroup,
|
||||
pub role_confidential_attribute_group: DepositRoleConfidentialAttributeGroup,
|
||||
pub private_attribute_group: DepositPrivateAttributeGroup,
|
||||
}
|
||||
|
||||
impl Deposit {
|
||||
pub const ITEM_NAME: &'static str = "deposit";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
public_attribute_group: DepositPublicAttributeGroup,
|
||||
role_confidential_attribute_group: DepositRoleConfidentialAttributeGroup,
|
||||
private_attribute_group: DepositPrivateAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Deposit {
|
||||
item,
|
||||
public_attribute_group,
|
||||
role_confidential_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_role_confidential_attribute_group =
|
||||
self.role_confidential_attribute_group.enc_group();
|
||||
|
||||
let enc_metadata_private = self
|
||||
.private_attribute_group
|
||||
.enc_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
Some(enc_role_confidential_attribute_group),
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Deposit:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Affiche les informations de l'objet `item`
|
||||
|
||||
println!("Public Attribute Group:");
|
||||
self.public_attribute_group.display_info(); // Affiche les informations du groupe d'attributs publics
|
||||
|
||||
println!("Role Confidential Attribute Group:");
|
||||
self.role_confidential_attribute_group.display_info(); // Affiche les informations du groupe d'attributs confidentiels
|
||||
|
||||
println!("Private Attribute Group:");
|
||||
self.private_attribute_group.display_info(); // Affiche les informations du groupe d'attributs privés
|
||||
}
|
||||
}
|
||||
18
src/models/item_enum.rs
Normal file
18
src/models/item_enum.rs
Normal file
@ -0,0 +1,18 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item_artefact::Artefact, item_commit::Commit, item_deposit::Deposit,
|
||||
item_Member::Member, item_Payments::Payments, item_peer::Peer,
|
||||
item_process::Process,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub enum ItemEnum {
|
||||
Process(Process),
|
||||
Peer(Peer),
|
||||
Member(Member),
|
||||
Payments(Payments),
|
||||
Deposit(Deposit),
|
||||
Artefact(Artefact),
|
||||
commit(Commit),
|
||||
}
|
||||
374
src/models/item_member.rs
Normal file
374
src/models/item_member.rs
Normal file
@ -0,0 +1,374 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MemberPublicAttributeGroup {
|
||||
pub sp_address_public: String,
|
||||
pub sp_address_public_sig: String,
|
||||
pub sp_address_revoke_public: String,
|
||||
pub sp_address_revoke_public_sig: String,
|
||||
pub third_sp_address_list_public: Vec<String>,
|
||||
pub data_size_max: i64,
|
||||
pub Payments_method_list_public: Vec<String>,
|
||||
pub succession_process_hash: String,
|
||||
}
|
||||
|
||||
impl MemberPublicAttributeGroup {
|
||||
pub fn new(
|
||||
sp_address_public: String,
|
||||
sp_address_public_sig: String,
|
||||
sp_address_revoke_public: String,
|
||||
sp_address_revoke_public_sig: String,
|
||||
third_sp_address_list_public: Vec<String>,
|
||||
data_size_max: i64,
|
||||
Payments_method_list_public: Vec<String>,
|
||||
succession_process_hash: String,
|
||||
) -> Self {
|
||||
MemberPublicAttributeGroup {
|
||||
sp_address_public,
|
||||
sp_address_public_sig,
|
||||
sp_address_revoke_public,
|
||||
sp_address_revoke_public_sig,
|
||||
third_sp_address_list_public,
|
||||
data_size_max,
|
||||
Payments_method_list_public,
|
||||
succession_process_hash,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let sp_address_public_enc = PcdItemEncAttributePublic::new(
|
||||
"sp_address_public".to_owned(),
|
||||
process_public_enc_key.enc_string(self.sp_address_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(sp_address_public_enc);
|
||||
|
||||
let sp_address_public_sig_enc = PcdItemEncAttributePublic::new(
|
||||
"sp_address_public_sig".to_owned(),
|
||||
process_public_enc_key.enc_string(self.sp_address_public_sig.clone()),
|
||||
);
|
||||
enc_attribute_list.push(sp_address_public_sig_enc);
|
||||
|
||||
let sp_address_revoke_public_enc = PcdItemEncAttributePublic::new(
|
||||
"sp_address_revoke_public".to_owned(),
|
||||
process_public_enc_key.enc_string(self.sp_address_revoke_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(sp_address_revoke_public_enc);
|
||||
|
||||
let sp_address_revoke_public_sig_enc = PcdItemEncAttributePublic::new(
|
||||
"sp_address_revoke_public_sig".to_owned(),
|
||||
process_public_enc_key.enc_string(self.sp_address_revoke_public_sig.clone()),
|
||||
);
|
||||
enc_attribute_list.push(sp_address_revoke_public_sig_enc);
|
||||
|
||||
let third_sp_address_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"third_sp_address_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.third_sp_address_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(third_sp_address_list_public_enc);
|
||||
|
||||
let data_size_max_enc = PcdItemEncAttributePublic::new(
|
||||
"data_size_max".to_owned(),
|
||||
process_public_enc_key.enc_i64(self.data_size_max),
|
||||
);
|
||||
enc_attribute_list.push(data_size_max_enc);
|
||||
|
||||
let Payments_method_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"Payments_method_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.Payments_method_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(Payments_method_list_public_enc);
|
||||
|
||||
let succession_process_hash_enc = PcdItemEncAttributePublic::new(
|
||||
"succession_process_hash".to_owned(),
|
||||
process_public_enc_key.enc_string(self.succession_process_hash.clone()),
|
||||
);
|
||||
enc_attribute_list.push(succession_process_hash_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MemberPublicAttributeGroup:");
|
||||
println!("SP Address Public: {}", self.sp_address_public);
|
||||
println!(
|
||||
"SP Address Public Signature: {}",
|
||||
self.sp_address_public_sig
|
||||
);
|
||||
println!(
|
||||
"SP Address Revoke Public: {}",
|
||||
self.sp_address_revoke_public
|
||||
);
|
||||
println!(
|
||||
"SP Address Revoke Public Signature: {}",
|
||||
self.sp_address_revoke_public_sig
|
||||
);
|
||||
println!(
|
||||
"Third SP Address List Public: {:?}",
|
||||
self.third_sp_address_list_public
|
||||
);
|
||||
println!("Data Size Max: {}", self.data_size_max);
|
||||
println!(
|
||||
"Payments Method List Public: {:?}",
|
||||
self.Payments_method_list_public
|
||||
);
|
||||
println!("Succession Process Hash: {}", self.succession_process_hash);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MemberRoleConfidentialAttributeGroup {
|
||||
pub Payments_method_list_confidential: Vec<String>,
|
||||
pub id_shard_info: String,
|
||||
}
|
||||
|
||||
impl MemberRoleConfidentialAttributeGroup {
|
||||
pub fn new(Payments_method_list_confidential: Vec<String>, id_shard_info: String) -> Self {
|
||||
MemberRoleConfidentialAttributeGroup {
|
||||
Payments_method_list_confidential,
|
||||
id_shard_info,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn enc_group(&self) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
let mut enc_Payments_method_list_confidential_key = KeyEncryption::new(
|
||||
Some("Payments_method_list_confidential".to_owned()),
|
||||
None,
|
||||
None,
|
||||
);
|
||||
if let Ok(_new) = enc_Payments_method_list_confidential_key.key_new_random() {
|
||||
let Payments_method_list_confidential_enc = PcdItemEncAttributeRoleConfidential::new(
|
||||
"Payments_method_list_confidential".to_owned(),
|
||||
enc_Payments_method_list_confidential_key
|
||||
.enc_vec_string(self.Payments_method_list_confidential.clone()),
|
||||
enc_Payments_method_list_confidential_key,
|
||||
);
|
||||
enc_attribute_list.push(Payments_method_list_confidential_enc);
|
||||
}
|
||||
|
||||
let mut enc_id_shard_info_key =
|
||||
KeyEncryption::new(Some("id_shard_info".to_owned()), None, None);
|
||||
|
||||
if let Ok(_new) = enc_id_shard_info_key.key_new_random() {
|
||||
let id_shard_info_enc = PcdItemEncAttributeRoleConfidential::new(
|
||||
"id_shard_info".to_owned(),
|
||||
enc_id_shard_info_key.enc_string(self.id_shard_info.clone()),
|
||||
enc_id_shard_info_key,
|
||||
);
|
||||
enc_attribute_list.push(id_shard_info_enc);
|
||||
}
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MemberRoleConfidentialAttributeGroup:");
|
||||
println!(
|
||||
"Confidential Payments Method List: {:?}",
|
||||
self.Payments_method_list_confidential
|
||||
);
|
||||
println!("ID Shard Info: {}", self.id_shard_info);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MemberPrivateAttributeGroup {
|
||||
pub Payments_method_list_private: Vec<String>,
|
||||
pub pcd_list: Vec<String>, // Assuming this is a list of strings
|
||||
pub prd_list_list: Vec<String>,
|
||||
pub prd_update_list: Vec<String>,
|
||||
pub prd_response_list: Vec<String>,
|
||||
pub prd_message_list: Vec<String>,
|
||||
pub prd_confirm_list: Vec<String>,
|
||||
pub prd_key_backup_list: Vec<String>,
|
||||
pub prd_key_hello_list: Vec<String>,
|
||||
pub tx_sp_list: Vec<String>,
|
||||
}
|
||||
|
||||
impl MemberPrivateAttributeGroup {
|
||||
pub fn new(
|
||||
Payments_method_list_private: Vec<String>,
|
||||
pcd_list: Vec<String>,
|
||||
prd_list_list: Vec<String>,
|
||||
prd_update_list: Vec<String>,
|
||||
prd_response_list: Vec<String>,
|
||||
prd_message_list: Vec<String>,
|
||||
prd_confirm_list: Vec<String>,
|
||||
prd_key_backup_list: Vec<String>,
|
||||
prd_key_hello_list: Vec<String>,
|
||||
tx_sp_list: Vec<String>,
|
||||
) -> Self {
|
||||
MemberPrivateAttributeGroup {
|
||||
Payments_method_list_private,
|
||||
pcd_list,
|
||||
prd_list_list,
|
||||
prd_update_list,
|
||||
prd_response_list,
|
||||
prd_message_list,
|
||||
prd_confirm_list,
|
||||
prd_key_backup_list,
|
||||
prd_key_hello_list,
|
||||
tx_sp_list,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn enc_group(&self, Member_enc_key: KeyEncryption) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let Payments_method_list_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"Payments_method_list_private".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.Payments_method_list_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(Payments_method_list_private_enc);
|
||||
|
||||
let pcd_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"pcd_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.pcd_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(pcd_list_enc);
|
||||
|
||||
let prd_list_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_list_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_list_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_list_list_enc);
|
||||
|
||||
let prd_update_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_update_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_update_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_update_list_enc);
|
||||
|
||||
let prd_response_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_response_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_response_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_response_list_enc);
|
||||
|
||||
let prd_message_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_message_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_message_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_message_list_enc);
|
||||
|
||||
let prd_confirm_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_confirm_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_confirm_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_confirm_list_enc);
|
||||
|
||||
let prd_key_backup_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_key_backup_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_key_backup_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_key_backup_list_enc);
|
||||
|
||||
let prd_key_hello_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"prd_key_hello_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.prd_key_hello_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(prd_key_hello_list_enc);
|
||||
|
||||
let tx_sp_list_enc = PcdItemEncAttributePrivate::new(
|
||||
"tx_sp_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.tx_sp_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(tx_sp_list_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MemberPrivateAttributeGroup:");
|
||||
println!(
|
||||
"Private Payments Method List: {:?}",
|
||||
self.Payments_method_list_private
|
||||
);
|
||||
println!("PCD List: {:?}", self.pcd_list);
|
||||
println!("PRD List List: {:?}", self.prd_list_list);
|
||||
println!("PRD Update List: {:?}", self.prd_update_list);
|
||||
println!("PRD Response List: {:?}", self.prd_response_list);
|
||||
println!("PRD `Envelope` List: {:?}", self.prd_message_list);
|
||||
println!("PRD Confirm List: {:?}", self.prd_confirm_list);
|
||||
println!("PRD Key Backup List: {:?}", self.prd_key_backup_list);
|
||||
println!("PRD Key Hello List: {:?}", self.prd_key_hello_list);
|
||||
println!("TX SP List: {:?}", self.tx_sp_list);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Member {
|
||||
pub item: Item,
|
||||
pub public_attribute_group: MemberPublicAttributeGroup,
|
||||
pub role_confidential_attribute_group: MemberRoleConfidentialAttributeGroup,
|
||||
pub private_attribute_group: MemberPrivateAttributeGroup,
|
||||
}
|
||||
|
||||
impl Member {
|
||||
pub const ITEM_NAME: &'static str = "Member";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
public_attribute_group: MemberPublicAttributeGroup,
|
||||
role_confidential_attribute_group: MemberRoleConfidentialAttributeGroup,
|
||||
private_attribute_group: MemberPrivateAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Member {
|
||||
item,
|
||||
public_attribute_group,
|
||||
role_confidential_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_role_confidential_attribute_group =
|
||||
self.role_confidential_attribute_group.enc_group();
|
||||
|
||||
let enc_metadata_private = self
|
||||
.private_attribute_group
|
||||
.enc_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
Some(enc_role_confidential_attribute_group),
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Member:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Affiche les informations de l'objet `item`
|
||||
|
||||
println!("Member Public Attribute Group:");
|
||||
self.public_attribute_group.display_info(); // Affiche les informations du groupe d'attributs publics
|
||||
|
||||
println!("Member Role Confidential Attribute Group:");
|
||||
self.role_confidential_attribute_group.display_info(); // Affiche les informations du groupe d'attributs confidentiels
|
||||
|
||||
println!("Member Private Attribute Group:");
|
||||
self.private_attribute_group.display_info(); // Affiche les informations du groupe d'attributs privés
|
||||
}
|
||||
}
|
||||
315
src/models/item_payment.rs
Normal file
315
src/models/item_payment.rs
Normal file
@ -0,0 +1,315 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PaymentsPublicAttributeGroup {
|
||||
pub for_sp_address_list: Vec<String>,
|
||||
pub goal_list: Vec<String>,
|
||||
pub provider_type: String,
|
||||
pub commit_pcd_hash_list: Vec<String>,
|
||||
pub order_pcd_hash_list: Vec<String>,
|
||||
pub invoice_pcd_hash_list: Vec<String>,
|
||||
pub pay_pcd_hash_list: Vec<String>,
|
||||
pub ref_item_hash_list: Vec<String>,
|
||||
pub ref_pcd_hash_list: Vec<String>,
|
||||
pub payload_list_public: Vec<String>,
|
||||
pub audit_code_list_public: Vec<String>,
|
||||
}
|
||||
|
||||
impl PaymentsPublicAttributeGroup {
|
||||
pub fn new(
|
||||
for_sp_address_list: Vec<String>,
|
||||
goal_list: Vec<String>,
|
||||
provider_type: String,
|
||||
commit_pcd_hash_list: Vec<String>,
|
||||
order_pcd_hash_list: Vec<String>,
|
||||
invoice_pcd_hash_list: Vec<String>,
|
||||
pay_pcd_hash_list: Vec<String>,
|
||||
ref_item_hash_list: Vec<String>,
|
||||
ref_pcd_hash_list: Vec<String>,
|
||||
payload_list_public: Vec<String>,
|
||||
audit_code_list_public: Vec<String>,
|
||||
) -> Self {
|
||||
PaymentsPublicAttributeGroup {
|
||||
for_sp_address_list,
|
||||
goal_list,
|
||||
provider_type,
|
||||
commit_pcd_hash_list,
|
||||
order_pcd_hash_list,
|
||||
invoice_pcd_hash_list,
|
||||
pay_pcd_hash_list,
|
||||
ref_item_hash_list,
|
||||
ref_pcd_hash_list,
|
||||
payload_list_public,
|
||||
audit_code_list_public,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let for_sp_address_list_enc = PcdItemEncAttributePublic::new(
|
||||
"for_sp_address_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.for_sp_address_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(for_sp_address_list_enc);
|
||||
|
||||
let goal_list_enc = PcdItemEncAttributePublic::new(
|
||||
"goal_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.goal_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(goal_list_enc);
|
||||
|
||||
let provider_type_enc = PcdItemEncAttributePublic::new(
|
||||
"provider_type".to_owned(),
|
||||
process_public_enc_key.enc_string(self.provider_type.clone()),
|
||||
);
|
||||
enc_attribute_list.push(provider_type_enc);
|
||||
|
||||
let commit_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"commit_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.commit_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(commit_pcd_hash_list_enc);
|
||||
|
||||
let order_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"order_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.order_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(order_pcd_hash_list_enc);
|
||||
|
||||
let invoice_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"invoice_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.invoice_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(invoice_pcd_hash_list_enc);
|
||||
|
||||
let pay_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"pay_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.pay_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(pay_pcd_hash_list_enc);
|
||||
|
||||
let ref_item_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_item_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_item_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_item_hash_list_enc);
|
||||
|
||||
let ref_pcd_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"ref_pcd_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.ref_pcd_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ref_pcd_hash_list_enc);
|
||||
|
||||
let payload_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"payload_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.payload_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_list_public_enc);
|
||||
|
||||
let audit_code_list_public_enc = PcdItemEncAttributePublic::new(
|
||||
"audit_code_list_public".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.audit_code_list_public.clone()),
|
||||
);
|
||||
enc_attribute_list.push(audit_code_list_public_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PaymentsPublicAttributeGroup:");
|
||||
println!("For SP Address List: {:?}", self.for_sp_address_list);
|
||||
println!("Goal List: {:?}", self.goal_list);
|
||||
println!("Provider Type: {}", self.provider_type);
|
||||
println!(
|
||||
"commit PCD Hash List: {:?}",
|
||||
self.commit_pcd_hash_list
|
||||
);
|
||||
println!("Order PCD Hash List: {:?}", self.order_pcd_hash_list);
|
||||
println!("Invoice PCD Hash List: {:?}", self.invoice_pcd_hash_list);
|
||||
println!("Pay PCD Hash List: {:?}", self.pay_pcd_hash_list);
|
||||
println!("Ref Item Hash List: {:?}", self.ref_item_hash_list);
|
||||
println!("Ref PCD Hash List: {:?}", self.ref_pcd_hash_list);
|
||||
println!("Payload List Public: {:?}", self.payload_list_public);
|
||||
println!("Audit Code List Public: {:?}", self.audit_code_list_public);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PaymentsRoleConfidentialAttributeGroup {
|
||||
pub payload_list_confidential: Vec<String>,
|
||||
pub audit_code_list_confidential: Vec<String>,
|
||||
}
|
||||
|
||||
impl PaymentsRoleConfidentialAttributeGroup {
|
||||
pub fn new(
|
||||
payload_list_confidential: Vec<String>,
|
||||
audit_code_list_confidential: Vec<String>,
|
||||
) -> Self {
|
||||
PaymentsRoleConfidentialAttributeGroup {
|
||||
payload_list_confidential,
|
||||
audit_code_list_confidential,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PaymentsRoleConfidentialAttributeGroup:");
|
||||
println!(
|
||||
"Confidential Payload List: {:?}",
|
||||
self.payload_list_confidential
|
||||
);
|
||||
println!(
|
||||
"Confidential Audit Code List: {:?}",
|
||||
self.audit_code_list_confidential
|
||||
);
|
||||
}
|
||||
|
||||
pub fn enc_group(&self) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
// tag_list
|
||||
let mut enc_payload_list_confidential =
|
||||
KeyEncryption::new(Some("payload_list_confidential".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_payload_list_confidential.key_new_random() {
|
||||
let enc_attribute_payload_list_confidential = PcdItemEncAttributeRoleConfidential::new(
|
||||
"payload_list_confidential".to_owned(),
|
||||
enc_payload_list_confidential
|
||||
.enc_vec_string(self.payload_list_confidential.clone()),
|
||||
enc_payload_list_confidential,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_payload_list_confidential);
|
||||
}
|
||||
|
||||
// zone_listaudit_code_list_confidential
|
||||
let mut enc_attribute_audit_code_list_confidential_key =
|
||||
KeyEncryption::new(Some("zone_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_audit_code_list_confidential_key.key_new_random() {
|
||||
let enc_attribute_audit_code_list_confidential =
|
||||
PcdItemEncAttributeRoleConfidential::new(
|
||||
"zone_list".to_owned(),
|
||||
enc_attribute_audit_code_list_confidential_key
|
||||
.enc_vec_string(self.audit_code_list_confidential.clone()),
|
||||
enc_attribute_audit_code_list_confidential_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_audit_code_list_confidential);
|
||||
}
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PaymentsPrivateAttributeGroup {
|
||||
pub payload_list_private: Vec<String>,
|
||||
pub audit_code_private: String,
|
||||
}
|
||||
|
||||
impl PaymentsPrivateAttributeGroup {
|
||||
pub fn new(payload_list_private: Vec<String>, audit_code_private: String) -> Self {
|
||||
PaymentsPrivateAttributeGroup {
|
||||
payload_list_private,
|
||||
audit_code_private,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PaymentsRoleConfidentialAttributeGroup:");
|
||||
println!("Confidential Payload List: {:?}", self.payload_list_private);
|
||||
println!(
|
||||
"Confidential Audit Code List: {:?}",
|
||||
self.audit_code_private
|
||||
);
|
||||
}
|
||||
|
||||
pub fn enc_group(&self, Member_enc_key: KeyEncryption) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let payload_list_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"payload_list".to_owned(),
|
||||
Member_enc_key.enc_vec_string(self.payload_list_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(payload_list_private_enc);
|
||||
|
||||
let audit_code_private_enc = PcdItemEncAttributePrivate::new(
|
||||
"audit_code_private".to_owned(),
|
||||
Member_enc_key.enc_string(self.audit_code_private.clone()),
|
||||
);
|
||||
enc_attribute_list.push(audit_code_private_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Payments {
|
||||
pub item: Item,
|
||||
pub public_attribute_group: PaymentsPublicAttributeGroup,
|
||||
pub role_confidential_attribute_group: PaymentsRoleConfidentialAttributeGroup,
|
||||
pub private_attribute_group: PaymentsPrivateAttributeGroup,
|
||||
}
|
||||
|
||||
impl Payments {
|
||||
pub const ITEM_NAME: &'static str = "Payments";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
public_attribute_group: PaymentsPublicAttributeGroup,
|
||||
role_confidential_attribute_group: PaymentsRoleConfidentialAttributeGroup,
|
||||
private_attribute_group: PaymentsPrivateAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Payments {
|
||||
item,
|
||||
public_attribute_group,
|
||||
role_confidential_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_role_confidential_attribute_group =
|
||||
self.role_confidential_attribute_group.enc_group();
|
||||
|
||||
let enc_metadata_private = self
|
||||
.private_attribute_group
|
||||
.enc_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
Some(enc_role_confidential_attribute_group),
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Payments:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Affiche les informations de l'objet `item`
|
||||
|
||||
println!("Public Attribute Group:");
|
||||
self.public_attribute_group.display_info(); // Affiche les informations du groupe d'attributs publics
|
||||
|
||||
println!("Role Confidential Attribute Group:");
|
||||
self.role_confidential_attribute_group.display_info(); // Affiche les informations du groupe d'attributs confidentiels
|
||||
|
||||
println!("Private Attribute Group:");
|
||||
self.private_attribute_group.display_info(); // Affiche les informations du groupe d'attributs privés
|
||||
}
|
||||
}
|
||||
233
src/models/item_peer.rs
Normal file
233
src/models/item_peer.rs
Normal file
@ -0,0 +1,233 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PeerPublicAttributeGroup {
|
||||
pub sp_address: String,
|
||||
pub domain: String,
|
||||
pub ip_address: String,
|
||||
pub pow_difficulty: u32,
|
||||
pub pow_pattern: String,
|
||||
pub pow_prefix: String,
|
||||
pub data_size_max: i64,
|
||||
pub timestamp_delay_max: u64,
|
||||
pub daily_hash_list: Vec<String>,
|
||||
pub daily_sp_tx_mine_list: Vec<String>,
|
||||
pub daily_sp_tx_mine_reward_list: Vec<String>,
|
||||
}
|
||||
|
||||
impl PeerPublicAttributeGroup {
|
||||
pub fn new(
|
||||
sp_address: String,
|
||||
domain: String,
|
||||
ip_address: String,
|
||||
pow_difficulty: u32,
|
||||
pow_pattern: String,
|
||||
pow_prefix: String,
|
||||
data_size_max: i64,
|
||||
timestamp_delay_max: u64,
|
||||
daily_hash_list: Vec<String>,
|
||||
daily_sp_tx_mine_list: Vec<String>,
|
||||
daily_sp_tx_mine_reward_list: Vec<String>,
|
||||
) -> Self {
|
||||
PeerPublicAttributeGroup {
|
||||
sp_address,
|
||||
domain,
|
||||
ip_address,
|
||||
pow_difficulty,
|
||||
pow_pattern,
|
||||
pow_prefix,
|
||||
data_size_max,
|
||||
timestamp_delay_max,
|
||||
daily_hash_list,
|
||||
daily_sp_tx_mine_list,
|
||||
daily_sp_tx_mine_reward_list,
|
||||
}
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let sp_address_enc = PcdItemEncAttributePublic::new(
|
||||
"sp_address".to_owned(),
|
||||
process_public_enc_key.enc_string(self.sp_address.clone()),
|
||||
);
|
||||
enc_attribute_list.push(sp_address_enc);
|
||||
|
||||
let domain_enc = PcdItemEncAttributePublic::new(
|
||||
"domain".to_owned(),
|
||||
process_public_enc_key.enc_string(self.domain.clone()),
|
||||
);
|
||||
enc_attribute_list.push(domain_enc);
|
||||
|
||||
let ip_address_enc = PcdItemEncAttributePublic::new(
|
||||
"ip_address".to_owned(),
|
||||
process_public_enc_key.enc_string(self.ip_address.clone()),
|
||||
);
|
||||
enc_attribute_list.push(ip_address_enc);
|
||||
|
||||
let pow_difficulty_enc = PcdItemEncAttributePublic::new(
|
||||
"pow_difficulty".to_owned(),
|
||||
process_public_enc_key.enc_u32(self.pow_difficulty),
|
||||
);
|
||||
enc_attribute_list.push(pow_difficulty_enc);
|
||||
|
||||
let pow_pattern_enc = PcdItemEncAttributePublic::new(
|
||||
"pow_pattern".to_owned(),
|
||||
process_public_enc_key.enc_string(self.pow_pattern.clone()),
|
||||
);
|
||||
enc_attribute_list.push(pow_pattern_enc);
|
||||
|
||||
let pow_prefix_enc = PcdItemEncAttributePublic::new(
|
||||
"pow_prefix".to_owned(),
|
||||
process_public_enc_key.enc_string(self.pow_prefix.clone()),
|
||||
);
|
||||
enc_attribute_list.push(pow_prefix_enc);
|
||||
|
||||
let data_size_max_enc = PcdItemEncAttributePublic::new(
|
||||
"data_size_max".to_owned(),
|
||||
process_public_enc_key.enc_i64(self.data_size_max),
|
||||
);
|
||||
enc_attribute_list.push(data_size_max_enc);
|
||||
|
||||
let timestamp_delay_max_enc = PcdItemEncAttributePublic::new(
|
||||
"timestamp_delay_max".to_owned(),
|
||||
process_public_enc_key.enc_u64(self.timestamp_delay_max),
|
||||
);
|
||||
enc_attribute_list.push(timestamp_delay_max_enc);
|
||||
|
||||
let daily_hash_list_enc = PcdItemEncAttributePublic::new(
|
||||
"daily_hash_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.daily_hash_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(daily_hash_list_enc);
|
||||
|
||||
let daily_sp_tx_mine_list_enc = PcdItemEncAttributePublic::new(
|
||||
"daily_sp_tx_mine_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.daily_sp_tx_mine_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(daily_sp_tx_mine_list_enc);
|
||||
|
||||
let daily_sp_tx_mine_reward_list_enc = PcdItemEncAttributePublic::new(
|
||||
"daily_sp_tx_mine_reward_list".to_owned(),
|
||||
process_public_enc_key.enc_vec_string(self.daily_sp_tx_mine_reward_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(daily_sp_tx_mine_reward_list_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PeerPublicAttributeGroup:");
|
||||
println!("SP Address: {}", self.sp_address);
|
||||
println!("Domain: {}", self.domain);
|
||||
println!("IP Address: {}", self.ip_address);
|
||||
println!("PoW Difficulty: {}", self.pow_difficulty);
|
||||
println!("PoW Pattern: {}", self.pow_pattern);
|
||||
println!("PoW Prefix: {}", self.pow_prefix);
|
||||
println!("Data Size Max: {}", self.data_size_max);
|
||||
println!("Timestamp Delay Max: {}", self.timestamp_delay_max);
|
||||
println!("Daily Hash List: {:?}", self.daily_hash_list);
|
||||
println!("Daily SP Tx Mine List: {:?}", self.daily_sp_tx_mine_list);
|
||||
println!(
|
||||
"Daily SP Tx Mine Reward List: {:?}",
|
||||
self.daily_sp_tx_mine_reward_list
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PeerPrivateAttributeGroup {
|
||||
pub config: String, // Assuming it's a simple string for now
|
||||
}
|
||||
|
||||
impl PeerPrivateAttributeGroup {
|
||||
pub fn new(config: String) -> Self {
|
||||
PeerPrivateAttributeGroup { config }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PeerPrivateAttributeGroup:");
|
||||
println!("Config: {}", self.config);
|
||||
}
|
||||
|
||||
pub fn enc_group(&self, Member_enc_key: KeyEncryption) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let config_enc = PcdItemEncAttributePrivate::new(
|
||||
"config".to_owned(),
|
||||
Member_enc_key.enc_string(self.config.clone()),
|
||||
);
|
||||
enc_attribute_list.push(config_enc);
|
||||
|
||||
enc_attribute_list
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Peer {
|
||||
pub item: Item,
|
||||
pub layer_list: Vec<String>,
|
||||
pub public_attribute_group: PeerPublicAttributeGroup,
|
||||
pub private_attribute_group: PeerPrivateAttributeGroup,
|
||||
}
|
||||
|
||||
impl Peer {
|
||||
pub const ITEM_NAME: &'static str = "peer";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
layer_list: Vec<String>,
|
||||
public_attribute_group: PeerPublicAttributeGroup,
|
||||
private_attribute_group: PeerPrivateAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Peer {
|
||||
item,
|
||||
layer_list,
|
||||
public_attribute_group,
|
||||
private_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
let enc_metadata_private = self
|
||||
.private_attribute_group
|
||||
.enc_group(Member_private_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
None,
|
||||
Some(enc_metadata_private),
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Peer:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Affiche les informations de l'objet `item`
|
||||
|
||||
println!("Layer List: {:?}", self.layer_list);
|
||||
|
||||
println!("Peer Public Attribute Group:");
|
||||
self.public_attribute_group.display_info(); // Affiche les informations du groupe d'attributs publics
|
||||
|
||||
println!("Peer Private Attribute Group:");
|
||||
self.private_attribute_group.display_info(); // Affiche les informations du groupe d'attributs privés
|
||||
}
|
||||
}
|
||||
86
src/models/item_process.rs
Normal file
86
src/models/item_process.rs
Normal file
@ -0,0 +1,86 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item::Item, key_encryption::KeyEncryption,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_generic_enc::PcdItemGenericEnc, roles_group::RolesGroup,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct ProcessPublicAttributeGroup {
|
||||
// Fields for public attributes
|
||||
// Example field
|
||||
pub roles_group: RolesGroup,
|
||||
}
|
||||
|
||||
impl ProcessPublicAttributeGroup {
|
||||
pub fn new(roles_group: RolesGroup) -> Self {
|
||||
ProcessPublicAttributeGroup { roles_group }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("ProcessPublicAttributeGroup:");
|
||||
println!("Roles Group:");
|
||||
self.roles_group.display_info(); // Display information for `roles_group`
|
||||
}
|
||||
pub fn enc_group(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
let roles_group_enc = PcdItemEncAttributePublic::new(
|
||||
"roles_group".to_owned(),
|
||||
process_public_enc_key.enc_roles_group(self.roles_group.clone()),
|
||||
);
|
||||
enc_attribute_list.push(roles_group_enc);
|
||||
enc_attribute_list
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Process {
|
||||
pub item: Item,
|
||||
pub item_process_public_attribute_group: ProcessPublicAttributeGroup,
|
||||
}
|
||||
|
||||
impl Process {
|
||||
pub const ITEM_NAME: &'static str = "process";
|
||||
pub fn new(
|
||||
mut item: Item,
|
||||
item_process_public_attribute_group: ProcessPublicAttributeGroup,
|
||||
) -> Self {
|
||||
item.name = Self::ITEM_NAME.to_string();
|
||||
Process {
|
||||
item,
|
||||
item_process_public_attribute_group,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Process:");
|
||||
println!("Item:");
|
||||
self.item.display_info(); // Display information for `item`
|
||||
|
||||
println!("Process Public Attribute Group:");
|
||||
self.item_process_public_attribute_group.display_info(); // Display information for `item_process_public_attribute_group`
|
||||
}
|
||||
pub fn enc(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> PcdItemGenericEnc {
|
||||
let enc_metadata_contract_public = self
|
||||
.item_process_public_attribute_group
|
||||
.enc_group(process_public_enc_key.clone());
|
||||
|
||||
PcdItemGenericEnc::new(
|
||||
self.item
|
||||
.enc(process_public_enc_key, Member_private_enc_key),
|
||||
Some(enc_metadata_contract_public),
|
||||
None,
|
||||
None,
|
||||
)
|
||||
}
|
||||
|
||||
// Additional methods for Process can be added here
|
||||
}
|
||||
248
src/models/key_encryption.rs
Normal file
248
src/models/key_encryption.rs
Normal file
@ -0,0 +1,248 @@
|
||||
use rand::RngCore;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::{json, Value};
|
||||
|
||||
use core::result::Result as CoreResult;
|
||||
|
||||
use super::metadata::Amount;
|
||||
use super::metadata::Number;
|
||||
use super::request_pcd::Pcd;
|
||||
use super::request_prd_confirm::PrdConfirm;
|
||||
use super::request_prd_key_backup::PrdKeyBackup;
|
||||
use super::request_prd_key_hello::PrdKeyHello;
|
||||
use super::request_prd_list::PrdList;
|
||||
use super::request_prd_message::PrdMessage;
|
||||
use super::request_prd_response::PrdResponse;
|
||||
use super::request_prd_update::PrdUpdate;
|
||||
use super::roles_group::RolesGroup;
|
||||
|
||||
use aes::cipher::consts::U32;
|
||||
use aes::cipher::generic_array::GenericArray;
|
||||
use aes_gcm::{
|
||||
aead::{AeadInPlace, KeyInit},
|
||||
Aes256Gcm,
|
||||
};
|
||||
use rand::rngs::OsRng;
|
||||
|
||||
pub struct Aes256GcmIv96Bit {
|
||||
pub key: GenericArray<u8, U32>,
|
||||
}
|
||||
|
||||
impl Aes256GcmIv96Bit {
|
||||
pub fn new() -> Self {
|
||||
let mut key_bytes = [0u8; 32];
|
||||
OsRng.fill_bytes(&mut key_bytes);
|
||||
let key = GenericArray::from_slice(&key_bytes);
|
||||
Aes256GcmIv96Bit { key: key.clone() }
|
||||
}
|
||||
|
||||
pub fn encrypt(&self, data: &[u8]) -> CoreResult<Vec<u8>, aes_gcm::Error> {
|
||||
let cipher = Aes256Gcm::new(&self.key);
|
||||
let mut nonce = [0u8; 12];
|
||||
OsRng.fill_bytes(&mut nonce);
|
||||
|
||||
let mut buffer = data.to_vec();
|
||||
cipher.encrypt_in_place(GenericArray::from_slice(&nonce), b"", &mut buffer)?;
|
||||
|
||||
Ok([nonce.to_vec(), buffer].concat())
|
||||
}
|
||||
|
||||
pub fn decrypt(&self, data: &[u8]) -> CoreResult<Vec<u8>, aes_gcm::Error> {
|
||||
if data.len() < 12 {
|
||||
return Err(aes_gcm::Error); // Remplacer par une erreur appropriée
|
||||
}
|
||||
|
||||
let (nonce, encrypted_data) = data.split_at(12);
|
||||
let mut buffer = encrypted_data.to_vec();
|
||||
let cipher = Aes256Gcm::new(&self.key);
|
||||
cipher.decrypt_in_place(GenericArray::from_slice(nonce), b"", &mut buffer)?;
|
||||
|
||||
Ok(buffer)
|
||||
}
|
||||
pub fn encrypt_string(&self, data: &str) -> CoreResult<String, String> {
|
||||
match self.encrypt(data.as_bytes()) {
|
||||
Ok(encrypted_data) => Ok(base64::encode(encrypted_data)),
|
||||
Err(_) => Err("Erreur de chiffrement".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn decrypt_string(&self, data: &str) -> CoreResult<String, String> {
|
||||
let decoded_data = match base64::decode(data) {
|
||||
Ok(data) => data,
|
||||
Err(_) => return Err("Erreur de décodage Base64".to_string()),
|
||||
};
|
||||
|
||||
match self.decrypt(&decoded_data) {
|
||||
Ok(decrypted_data) => match String::from_utf8(decrypted_data) {
|
||||
Ok(text) => Ok(text),
|
||||
Err(_) => Err("Erreur de conversion UTF-8".to_string()),
|
||||
},
|
||||
Err(_) => Err("Erreur de déchiffrement".to_string()),
|
||||
}
|
||||
}
|
||||
pub fn export_key(&self) -> String {
|
||||
base64::encode(&self.key)
|
||||
}
|
||||
|
||||
pub fn import_key(encoded_key: &str) -> CoreResult<Self, String> {
|
||||
match base64::decode(encoded_key) {
|
||||
Ok(decoded_key) => {
|
||||
if decoded_key.len() == 32 {
|
||||
let key = GenericArray::from_slice(&decoded_key);
|
||||
Ok(Aes256GcmIv96Bit { key: key.clone() })
|
||||
} else {
|
||||
Err("La taille de la clé n'est pas valide".to_string())
|
||||
}
|
||||
}
|
||||
Err(_) => Err("Échec du décodage de la clé".to_string()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct KeyEncryption {
|
||||
pub attribute_name: Option<String>,
|
||||
pub key: Option<String>,
|
||||
pub algorithm: Option<String>,
|
||||
}
|
||||
|
||||
impl KeyEncryption {
|
||||
pub fn new(
|
||||
attribute_name: Option<String>,
|
||||
key: Option<String>,
|
||||
algorithm: Option<String>,
|
||||
) -> Self {
|
||||
KeyEncryption {
|
||||
attribute_name,
|
||||
key,
|
||||
algorithm,
|
||||
}
|
||||
}
|
||||
pub fn key_new_random(&mut self) -> CoreResult<String, String> {
|
||||
let new_key = Aes256GcmIv96Bit::new().export_key();
|
||||
self.key = Some(new_key.clone());
|
||||
Ok(new_key)
|
||||
}
|
||||
pub fn encode(&self, data: String) -> CoreResult<String, String> {
|
||||
if let Some(ref key) = self.key {
|
||||
let decoded_key = Aes256GcmIv96Bit::import_key(key)?;
|
||||
let encrypted_data = decoded_key.encrypt_string(&data)?;
|
||||
Ok(encrypted_data)
|
||||
} else {
|
||||
Err("Aucune clé n'est définie".to_string())
|
||||
}
|
||||
}
|
||||
|
||||
pub fn decode(&self, encrypted_data: String) -> CoreResult<String, String> {
|
||||
if let Some(ref key) = self.key {
|
||||
let decoded_key = Aes256GcmIv96Bit::import_key(key)?;
|
||||
let decrypted_data = decoded_key.decrypt_string(&encrypted_data)?;
|
||||
Ok(decrypted_data)
|
||||
} else {
|
||||
Err("Aucune clé n'est définie".to_string())
|
||||
}
|
||||
}
|
||||
|
||||
pub fn display_info(&self) {
|
||||
println!("KeyEncryption:");
|
||||
println!("Attribute Name: {:?}", self.attribute_name);
|
||||
println!("Key: {:?}", self.key);
|
||||
println!("Algorithm: {:?}", self.algorithm);
|
||||
}
|
||||
pub fn enc(&self, data: Value) -> String {
|
||||
let data_string = serde_json::to_string(&data).unwrap_or_else(|_| "".to_string());
|
||||
self.encode(data_string).unwrap_or_else(|_| "".to_string())
|
||||
}
|
||||
pub fn enc_string(&self, data: String) -> String {
|
||||
self.enc(Value::String(data))
|
||||
}
|
||||
pub fn enc_i64(&self, data: i64) -> String {
|
||||
self.enc(Value::Number(data.into()))
|
||||
}
|
||||
pub fn enc_u64(&self, data: u64) -> String {
|
||||
self.enc(Value::Number(data.into()))
|
||||
}
|
||||
pub fn enc_u32(&self, data: u32) -> String {
|
||||
self.enc(Value::Number(data.into()))
|
||||
}
|
||||
pub fn enc_vec_string(&self, list: Vec<String>) -> String {
|
||||
self.enc(Value::Array(list.into_iter().map(Value::String).collect()))
|
||||
}
|
||||
pub fn enc_vec_key_encryption(&self, list: Vec<KeyEncryption>) -> String {
|
||||
// Utilisez `serde_json::to_value` pour convertir chaque `KeyEncryption` en `Value`
|
||||
let json_list: Vec<Value> = list
|
||||
.into_iter()
|
||||
.map(|key_enc| serde_json::to_value(key_enc).unwrap_or_else(|_| json!({})))
|
||||
.collect();
|
||||
|
||||
self.enc(Value::Array(json_list))
|
||||
}
|
||||
pub fn enc_amount(&self, amount: Amount) -> String {
|
||||
let amount_value = serde_json::to_value(amount).unwrap_or_else(|_| json!({}));
|
||||
self.enc(amount_value)
|
||||
}
|
||||
pub fn enc_number(&self, number: Number) -> String {
|
||||
let number_value = serde_json::to_value(number).unwrap_or_else(|_| json!({}));
|
||||
self.enc(number_value)
|
||||
}
|
||||
pub fn enc_bool(&self, data: bool) -> String {
|
||||
self.enc(Value::Bool(data))
|
||||
}
|
||||
pub fn enc_vec_u32(&self, list: Vec<u32>) -> String {
|
||||
let number_list: Vec<Value> = list
|
||||
.into_iter()
|
||||
.map(|num| Value::Number(serde_json::Number::from(num)))
|
||||
.collect();
|
||||
|
||||
self.enc(Value::Array(number_list))
|
||||
}
|
||||
|
||||
pub fn enc_vec_i64(&self, list: Vec<i64>) -> String {
|
||||
let number_list: Vec<Value> = list
|
||||
.into_iter()
|
||||
.map(|num| Value::Number(serde_json::Number::from(num)))
|
||||
.collect();
|
||||
|
||||
self.enc(Value::Array(number_list))
|
||||
}
|
||||
pub fn enc_vec_bool(&self, list: Vec<bool>) -> String {
|
||||
self.enc(Value::Array(list.into_iter().map(Value::Bool).collect()))
|
||||
}
|
||||
pub fn enc_pcd(&self, pcd: Pcd) -> String {
|
||||
let pcd_value = serde_json::to_value(pcd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(pcd_value)
|
||||
}
|
||||
pub fn enc_prd_update(&self, prd: PrdUpdate) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_list(&self, pcd: PrdList) -> String {
|
||||
let prd_value = serde_json::to_value(pcd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_response(&self, prd: PrdResponse) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_confirm(&self, prd: PrdConfirm) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_message(&self, prd: PrdMessage) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_key_backup(&self, prd: PrdKeyBackup) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_prd_key_hello(&self, prd: PrdKeyHello) -> String {
|
||||
let prd_value = serde_json::to_value(prd).unwrap_or_else(|_| json!({}));
|
||||
self.enc(prd_value)
|
||||
}
|
||||
pub fn enc_roles_group(&self, roles: RolesGroup) -> String {
|
||||
let roles_value = serde_json::to_value(roles).unwrap_or_else(|_| json!({}));
|
||||
self.enc(roles_value)
|
||||
}
|
||||
}
|
||||
108
src/models/message.rs
Normal file
108
src/models/message.rs
Normal file
@ -0,0 +1,108 @@
|
||||
use chrono::Utc;
|
||||
|
||||
use sha2::{Digest, Sha256};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::shared_peer::Peer;
|
||||
use super::shared_process::Process;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Pow {
|
||||
pub data_hash: String,
|
||||
timestamp: Option<u64>,
|
||||
pub nonce: Option<u64>,
|
||||
pub pathern: String,
|
||||
pub difficulty: usize,
|
||||
}
|
||||
|
||||
impl Pow {
|
||||
pub fn new(data_hash: String, pathern: String, difficulty: usize) -> Self {
|
||||
let mut pow = Pow {
|
||||
data_hash,
|
||||
nonce: None,
|
||||
timestamp: None,
|
||||
pathern,
|
||||
difficulty,
|
||||
};
|
||||
pow.find();
|
||||
return pow;
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Pow:");
|
||||
println!("Data Hash: {}", self.data_hash);
|
||||
println!("Timestamp: {}", self.timestamp.as_ref().unwrap_or(&0));
|
||||
println!("Nonce: {}", self.nonce.as_ref().unwrap_or(&0));
|
||||
println!("Pathern: {}", self.pathern);
|
||||
println!("Difficulty: {}", self.difficulty);
|
||||
}
|
||||
pub fn find(&mut self) {
|
||||
let mut nonce: u64 = 0;
|
||||
loop {
|
||||
// Mise à jour du timestamp à chaque itération
|
||||
let current_timestamp = Utc::now().timestamp() as u64;
|
||||
self.timestamp = Some(current_timestamp);
|
||||
|
||||
// Créer une chaîne avec le hash actuel, le timestamp et le nonce
|
||||
let data: String = format!("{}{}{}", self.data_hash, current_timestamp, nonce);
|
||||
|
||||
// Calculer le hash SHA-256
|
||||
let mut hasher = Sha256::new();
|
||||
hasher.update(data);
|
||||
let result = hasher.finalize();
|
||||
let hash_str: String = format!("{:x}", result);
|
||||
|
||||
// Vérifier si le hash correspond au motif de difficulté
|
||||
if hash_str.starts_with(&"0".repeat(self.difficulty as usize)) {
|
||||
self.nonce = Some(nonce);
|
||||
break;
|
||||
}
|
||||
|
||||
nonce += 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct `Envelope` {
|
||||
pub shared_peer_list: Vec<Peer>,
|
||||
pub shared_process_list: Vec<Process>,
|
||||
pub faucet_sp_address: String,
|
||||
pub pow: Pow, // Assuming Pow is a predefined struct
|
||||
}
|
||||
|
||||
impl `Envelope` {
|
||||
pub fn new(
|
||||
shared_peer_list: Vec<Peer>,
|
||||
shared_process_list: Vec<Process>,
|
||||
faucet_sp_address: String,
|
||||
pow_data_hash: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> Self {
|
||||
let pow: Pow = Pow::new(pow_data_hash, pow_pathern, pow_difficulty);
|
||||
`Envelope` {
|
||||
shared_peer_list,
|
||||
shared_process_list,
|
||||
faucet_sp_address,
|
||||
pow,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Message:");
|
||||
println!("Shared Peer List:");
|
||||
for shared_peer in &self.shared_peer_list {
|
||||
shared_peer.display_info(); // Assuming Peers has a display_info method
|
||||
}
|
||||
|
||||
println!("Shared Process List:");
|
||||
for shared_process in &self.shared_process_list {
|
||||
shared_process.display_info(); // Assuming Process has a display_info method
|
||||
}
|
||||
|
||||
println!("Faucet SP Address: {}", self.faucet_sp_address);
|
||||
println!("PoW:");
|
||||
self.pow.display_info(); // Assuming Pow has a display_info method
|
||||
}
|
||||
}
|
||||
51
src/models/message_client.rs
Normal file
51
src/models/message_client.rs
Normal file
@ -0,0 +1,51 @@
|
||||
use super::{message::Message, shared_peer::Peer, shared_process::Process};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct `Envelope` Client {
|
||||
pub `Envelope` : `Envelope` , // Assuming `Envelope` is a predefined struct
|
||||
pub request_enc: String,
|
||||
pub request_hash: String,
|
||||
}
|
||||
|
||||
impl `Envelope` Client {
|
||||
pub fn new(
|
||||
request_enc: String,
|
||||
request_hash: String,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> Self {
|
||||
let pow_data_hash = request_hash;
|
||||
let `Envelope` : `Envelope` = `Envelope` ::new(
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_data_hash.clone(),
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
);
|
||||
`Envelope` Client {
|
||||
`Envelope` ,
|
||||
request_enc,
|
||||
request_hash: pow_data_hash,
|
||||
}
|
||||
}
|
||||
pub fn send(&self) {
|
||||
for shared_peer in &self.`Envelope`.shared_peer_list {
|
||||
shared_peer.send_message_client(self.clone()); // Assuming Peers has a send method
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("EnvelopeClient:");
|
||||
println!("Message:");
|
||||
self.`Envelope`.display_info(); // Assuming `Envelope` has a display_info method
|
||||
println!("Envelope hash: {}", self.request_hash);
|
||||
|
||||
println!("Request Enc: {}", self.request_enc);
|
||||
}
|
||||
}
|
||||
19
src/models/message_connect.rs
Normal file
19
src/models/message_connect.rs
Normal file
@ -0,0 +1,19 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::message::Message;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct `Envelope` Connect {
|
||||
pub `Envelope` : `Envelope` , // Assuming `Envelope` is a predefined struct
|
||||
}
|
||||
|
||||
impl `Envelope` Connect {
|
||||
pub fn new(message: `Envelope` ) -> Self {
|
||||
`Envelope` Connect { `Envelope` }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("EnvelopeConnect:");
|
||||
println!("Message:");
|
||||
self.`Envelope`.display_info(); // Assuming `Envelope` has a display_info method
|
||||
}
|
||||
}
|
||||
145
src/models/metadata.rs
Normal file
145
src/models/metadata.rs
Normal file
@ -0,0 +1,145 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::key_encryption::KeyEncryption;
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Number {
|
||||
pub fixed_state: bool,
|
||||
pub number: i32,
|
||||
pub number_unit: String,
|
||||
}
|
||||
|
||||
impl Number {
|
||||
// Constructor for Number struct
|
||||
pub fn new(fixed_state: bool, number: i32, number_unit: String) -> Self {
|
||||
Number {
|
||||
fixed_state,
|
||||
number,
|
||||
number_unit,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Number:");
|
||||
println!("Fixed State: {}", self.fixed_state);
|
||||
println!("Number: {}", self.number);
|
||||
println!("Number Unit: {}", self.number_unit);
|
||||
}
|
||||
|
||||
// Additional methods for Number can be added here.
|
||||
}
|
||||
|
||||
// Struct for representing an amount with various attributes.
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Amount {
|
||||
pub timestamp: u64,
|
||||
pub change_source_list: Vec<String>,
|
||||
pub amount_cent: i64,
|
||||
pub amount_unit: String,
|
||||
pub amount_unit_ref: String, // This can be a reference to an external unit system.
|
||||
}
|
||||
|
||||
impl Amount {
|
||||
// Constructor for Amount struct
|
||||
pub fn new(
|
||||
timestamp: u64,
|
||||
change_source_list: Vec<String>,
|
||||
amount_cent: i64,
|
||||
amount_unit: String,
|
||||
amount_unit_ref: String,
|
||||
) -> Self {
|
||||
Amount {
|
||||
timestamp,
|
||||
change_source_list,
|
||||
amount_cent,
|
||||
amount_unit,
|
||||
amount_unit_ref,
|
||||
}
|
||||
}
|
||||
pub fn display(&self) -> String {
|
||||
format!(
|
||||
"Amount: {} {} {} {} {}",
|
||||
self.timestamp,
|
||||
self.change_source_list.join(","),
|
||||
self.amount_cent,
|
||||
self.amount_unit,
|
||||
self.amount_unit_ref
|
||||
)
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Amount:");
|
||||
println!("Timestamp: {}", self.timestamp);
|
||||
println!("Change Source List: {:?}", self.change_source_list);
|
||||
println!("Amount cent: {}", self.amount_cent);
|
||||
println!("Amount Unit: {}", self.amount_unit);
|
||||
println!("Amount Unit Reference: {}", self.amount_unit_ref);
|
||||
}
|
||||
// Additional methods for Amount can be added here.
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MetaData {
|
||||
pub tag_list: Vec<String>,
|
||||
pub zone_list: Vec<String>,
|
||||
pub label_list: Vec<String>,
|
||||
pub ref_list: Vec<String>,
|
||||
pub data_list: Vec<String>,
|
||||
pub amount: Amount,
|
||||
pub number: Number,
|
||||
pub render_template_list: Vec<String>,
|
||||
pub legal_text_list: Vec<String>,
|
||||
pub key_list: Vec<KeyEncryption>,
|
||||
}
|
||||
|
||||
impl MetaData {
|
||||
pub fn new(
|
||||
tag_list: Vec<String>,
|
||||
zone_list: Vec<String>,
|
||||
label_list: Vec<String>,
|
||||
ref_list: Vec<String>,
|
||||
data_list: Vec<String>,
|
||||
amount: Amount,
|
||||
number: Number,
|
||||
render_template_list: Vec<String>,
|
||||
legal_text_list: Vec<String>,
|
||||
key_list: Vec<KeyEncryption>,
|
||||
) -> Self {
|
||||
MetaData {
|
||||
tag_list,
|
||||
zone_list,
|
||||
label_list,
|
||||
ref_list,
|
||||
data_list,
|
||||
amount,
|
||||
number,
|
||||
render_template_list,
|
||||
legal_text_list,
|
||||
key_list,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MetaData:");
|
||||
println!("Tag List: {:?}", self.tag_list);
|
||||
println!("Zone List: {:?}", self.zone_list);
|
||||
println!("Label List: {:?}", self.label_list);
|
||||
println!("Ref List: {:?}", self.ref_list);
|
||||
println!("Data List: {:?}", self.data_list);
|
||||
|
||||
println!("Amount:");
|
||||
self.amount.display_info(); // Assuming Amount has a display_info method
|
||||
|
||||
println!("Number:");
|
||||
self.number.display_info(); // Assuming Number has a display_info method
|
||||
|
||||
println!("Render Template List: {:?}", self.render_template_list);
|
||||
println!("Legal Text List: {:?}", self.legal_text_list);
|
||||
|
||||
println!("Key List:");
|
||||
for key in &self.key_list {
|
||||
key.display_info(); // Assuming KeyEncryption has a display_info method
|
||||
}
|
||||
}
|
||||
|
||||
// Methods for manipulating MetaData can be added here.
|
||||
}
|
||||
143
src/models/metadata_contract_public.rs
Normal file
143
src/models/metadata_contract_public.rs
Normal file
@ -0,0 +1,143 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, metadata::MetaData,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MetadataContractPublic {
|
||||
pub meta_data: MetaData,
|
||||
}
|
||||
|
||||
impl MetadataContractPublic {
|
||||
pub fn new(meta_data: MetaData) -> Self {
|
||||
MetadataContractPublic { meta_data }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MetadataContractPublic:");
|
||||
// Assuming MetaData has a display_info method
|
||||
self.meta_data.display_info(); // Display information for `meta_data`
|
||||
}
|
||||
pub fn enc_list(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePublic> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePublic> = Vec::new();
|
||||
|
||||
let enc_attribute_tag_list_key = KeyEncryption::new(
|
||||
Some("tag_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_tag_list = PcdItemEncAttributePublic::new(
|
||||
"tag_list".to_owned(),
|
||||
enc_attribute_tag_list_key.enc_vec_string(self.meta_data.tag_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_tag_list);
|
||||
|
||||
let enc_attribute_zone_list_key = KeyEncryption::new(
|
||||
Some("zone_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_zone_list = PcdItemEncAttributePublic::new(
|
||||
"zone_list".to_owned(),
|
||||
enc_attribute_zone_list_key.enc_vec_string(self.meta_data.zone_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_zone_list);
|
||||
|
||||
let enc_attribute_label_list_key = KeyEncryption::new(
|
||||
Some("label_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_label_list = PcdItemEncAttributePublic::new(
|
||||
"label_list".to_owned(),
|
||||
enc_attribute_label_list_key.enc_vec_string(self.meta_data.label_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_label_list);
|
||||
|
||||
let enc_attribute_ref_list_key = KeyEncryption::new(
|
||||
Some("ref_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_ref_list = PcdItemEncAttributePublic::new(
|
||||
"ref_list".to_owned(),
|
||||
enc_attribute_ref_list_key.enc_vec_string(self.meta_data.ref_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_ref_list);
|
||||
|
||||
let enc_attribute_data_list_key = KeyEncryption::new(
|
||||
Some("data_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_data_list = PcdItemEncAttributePublic::new(
|
||||
"data_list".to_owned(),
|
||||
enc_attribute_data_list_key.enc_vec_string(self.meta_data.data_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_data_list);
|
||||
|
||||
let enc_attribute_amount_key = KeyEncryption::new(
|
||||
Some("amount".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_amount = PcdItemEncAttributePublic::new(
|
||||
"amount".to_owned(),
|
||||
enc_attribute_amount_key.enc_amount(self.meta_data.amount.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_amount);
|
||||
|
||||
let enc_attribute_number_key = KeyEncryption::new(
|
||||
Some("number".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_number = PcdItemEncAttributePublic::new(
|
||||
"number".to_owned(),
|
||||
enc_attribute_number_key.enc_number(self.meta_data.number.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_number);
|
||||
|
||||
let enc_attribute_render_template_list_key = KeyEncryption::new(
|
||||
Some("render_template_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_render_template_list = PcdItemEncAttributePublic::new(
|
||||
"render_template_list".to_owned(),
|
||||
enc_attribute_render_template_list_key
|
||||
.enc_vec_string(self.meta_data.render_template_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_render_template_list);
|
||||
|
||||
let enc_attribute_legal_text_list_key = KeyEncryption::new(
|
||||
Some("legal_text_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_legal_text_list = PcdItemEncAttributePublic::new(
|
||||
"legal_text_list".to_owned(),
|
||||
enc_attribute_legal_text_list_key
|
||||
.enc_vec_string(self.meta_data.legal_text_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_legal_text_list);
|
||||
|
||||
let enc_attribute_key_list_key = KeyEncryption::new(
|
||||
Some("key_list".to_owned()),
|
||||
process_public_enc_key.key.clone(),
|
||||
process_public_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_key_list = PcdItemEncAttributePublic::new(
|
||||
"key_list".to_owned(),
|
||||
enc_attribute_key_list_key.enc_vec_key_encryption(self.meta_data.key_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_key_list);
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
}
|
||||
143
src/models/metadata_private.rs
Normal file
143
src/models/metadata_private.rs
Normal file
@ -0,0 +1,143 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, metadata::MetaData,
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MetadataPrivate {
|
||||
pub meta_data: MetaData,
|
||||
}
|
||||
|
||||
impl MetadataPrivate {
|
||||
pub fn new(meta_data: MetaData) -> Self {
|
||||
MetadataPrivate { meta_data }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MetadataPrivate:");
|
||||
// Assuming MetaData has a display_info method
|
||||
self.meta_data.display_info(); // Display information for `meta_data`
|
||||
}
|
||||
pub fn enc_list(
|
||||
&self,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> Vec<PcdItemEncAttributePrivate> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributePrivate> = Vec::new();
|
||||
|
||||
let enc_attribute_tag_list_key = KeyEncryption::new(
|
||||
Some("tag_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_tag_list = PcdItemEncAttributePrivate::new(
|
||||
"tag_list".to_owned(),
|
||||
enc_attribute_tag_list_key.enc_vec_string(self.meta_data.tag_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_tag_list);
|
||||
|
||||
let enc_attribute_zone_list_key = KeyEncryption::new(
|
||||
Some("zone_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_zone_list = PcdItemEncAttributePrivate::new(
|
||||
"zone_list".to_owned(),
|
||||
enc_attribute_zone_list_key.enc_vec_string(self.meta_data.zone_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_zone_list);
|
||||
|
||||
let enc_attribute_label_list_key = KeyEncryption::new(
|
||||
Some("label_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_label_list = PcdItemEncAttributePrivate::new(
|
||||
"label_list".to_owned(),
|
||||
enc_attribute_label_list_key.enc_vec_string(self.meta_data.label_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_label_list);
|
||||
|
||||
let enc_attribute_ref_list_key = KeyEncryption::new(
|
||||
Some("ref_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_ref_list = PcdItemEncAttributePrivate::new(
|
||||
"ref_list".to_owned(),
|
||||
enc_attribute_ref_list_key.enc_vec_string(self.meta_data.ref_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_ref_list);
|
||||
|
||||
let enc_attribute_data_list_key = KeyEncryption::new(
|
||||
Some("data_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_data_list = PcdItemEncAttributePrivate::new(
|
||||
"data_list".to_owned(),
|
||||
enc_attribute_data_list_key.enc_vec_string(self.meta_data.data_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_data_list);
|
||||
|
||||
let enc_attribute_amount_key = KeyEncryption::new(
|
||||
Some("amount".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_amount = PcdItemEncAttributePrivate::new(
|
||||
"amount".to_owned(),
|
||||
enc_attribute_amount_key.enc_amount(self.meta_data.amount.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_amount);
|
||||
|
||||
let enc_attribute_number_key = KeyEncryption::new(
|
||||
Some("number".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_number = PcdItemEncAttributePrivate::new(
|
||||
"number".to_owned(),
|
||||
enc_attribute_number_key.enc_number(self.meta_data.number.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_number);
|
||||
|
||||
let enc_attribute_render_template_list_key = KeyEncryption::new(
|
||||
Some("render_template_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_render_template_list = PcdItemEncAttributePrivate::new(
|
||||
"render_template_list".to_owned(),
|
||||
enc_attribute_render_template_list_key
|
||||
.enc_vec_string(self.meta_data.render_template_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_render_template_list);
|
||||
|
||||
let enc_attribute_legal_text_list_key = KeyEncryption::new(
|
||||
Some("legal_text_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_legal_text_list = PcdItemEncAttributePrivate::new(
|
||||
"legal_text_list".to_owned(),
|
||||
enc_attribute_legal_text_list_key
|
||||
.enc_vec_string(self.meta_data.legal_text_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_legal_text_list);
|
||||
|
||||
let enc_attribute_key_list_key = KeyEncryption::new(
|
||||
Some("key_list".to_owned()),
|
||||
Member_private_enc_key.key.clone(),
|
||||
Member_private_enc_key.algorithm.clone(),
|
||||
);
|
||||
let enc_attribute_key_list = PcdItemEncAttributePrivate::new(
|
||||
"key_list".to_owned(),
|
||||
enc_attribute_key_list_key.enc_vec_key_encryption(self.meta_data.key_list.clone()),
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_key_list);
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
}
|
||||
152
src/models/metadata_role_confidential.rs
Normal file
152
src/models/metadata_role_confidential.rs
Normal file
@ -0,0 +1,152 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, metadata::MetaData,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct MetadataRoleConfidential {
|
||||
pub meta_data: MetaData,
|
||||
}
|
||||
|
||||
impl MetadataRoleConfidential {
|
||||
pub fn new(meta_data: MetaData) -> Self {
|
||||
MetadataRoleConfidential { meta_data }
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("MetadataRoleConfidential:");
|
||||
// Assuming MetaData has a display_info method
|
||||
self.meta_data.display_info(); // Display information for `meta_data`
|
||||
}
|
||||
pub fn enc_list(&self) -> Vec<PcdItemEncAttributeRoleConfidential> {
|
||||
let mut enc_attribute_list: Vec<PcdItemEncAttributeRoleConfidential> = Vec::new();
|
||||
|
||||
// tag_list
|
||||
let mut enc_attribute_tag_list_key =
|
||||
KeyEncryption::new(Some("tag_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_tag_list_key.key_new_random() {
|
||||
let enc_attribute_tag_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"tag_list".to_owned(),
|
||||
enc_attribute_tag_list_key.enc_vec_string(self.meta_data.tag_list.clone()),
|
||||
enc_attribute_tag_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_tag_list);
|
||||
}
|
||||
|
||||
// zone_list
|
||||
let mut enc_attribute_zone_list_key =
|
||||
KeyEncryption::new(Some("zone_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_zone_list_key.key_new_random() {
|
||||
let enc_attribute_zone_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"zone_list".to_owned(),
|
||||
enc_attribute_zone_list_key.enc_vec_string(self.meta_data.zone_list.clone()),
|
||||
enc_attribute_zone_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_zone_list);
|
||||
}
|
||||
|
||||
// label_list
|
||||
let mut enc_attribute_label_list_key =
|
||||
KeyEncryption::new(Some("label_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_label_list_key.key_new_random() {
|
||||
let enc_attribute_label_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"label_list".to_owned(),
|
||||
enc_attribute_label_list_key.enc_vec_string(self.meta_data.label_list.clone()),
|
||||
enc_attribute_label_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_label_list);
|
||||
}
|
||||
|
||||
// ref_list
|
||||
let mut enc_attribute_ref_list_key =
|
||||
KeyEncryption::new(Some("ref_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_ref_list_key.key_new_random() {
|
||||
let enc_attribute_ref_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"ref_list".to_owned(),
|
||||
enc_attribute_ref_list_key.enc_vec_string(self.meta_data.ref_list.clone()),
|
||||
enc_attribute_ref_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_ref_list);
|
||||
}
|
||||
|
||||
// data_list
|
||||
let mut enc_attribute_data_list_key =
|
||||
KeyEncryption::new(Some("data_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_data_list_key.key_new_random() {
|
||||
let enc_attribute_data_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"data_list".to_owned(),
|
||||
enc_attribute_data_list_key.enc_vec_string(self.meta_data.data_list.clone()),
|
||||
enc_attribute_data_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_data_list);
|
||||
}
|
||||
|
||||
// amount
|
||||
let mut enc_attribute_amount_key =
|
||||
KeyEncryption::new(Some("amount".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_amount_key.key_new_random() {
|
||||
let enc_attribute_amount = PcdItemEncAttributeRoleConfidential::new(
|
||||
"amount".to_owned(),
|
||||
enc_attribute_amount_key.enc_amount(self.meta_data.amount.clone()),
|
||||
enc_attribute_amount_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_amount);
|
||||
}
|
||||
|
||||
// number
|
||||
let mut enc_attribute_number_key =
|
||||
KeyEncryption::new(Some("number".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_number_key.key_new_random() {
|
||||
let enc_attribute_number = PcdItemEncAttributeRoleConfidential::new(
|
||||
"number".to_owned(),
|
||||
enc_attribute_number_key.enc_number(self.meta_data.number.clone()),
|
||||
enc_attribute_number_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_number);
|
||||
}
|
||||
|
||||
// render_template_list
|
||||
let mut enc_attribute_render_template_list_key =
|
||||
KeyEncryption::new(Some("render_template_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_render_template_list_key.key_new_random() {
|
||||
let enc_attribute_render_template_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"render_template_list".to_owned(),
|
||||
enc_attribute_render_template_list_key
|
||||
.enc_vec_string(self.meta_data.render_template_list.clone()),
|
||||
enc_attribute_render_template_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_render_template_list);
|
||||
}
|
||||
|
||||
// legal_text_list
|
||||
let mut enc_attribute_legal_text_list_key =
|
||||
KeyEncryption::new(Some("legal_text_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_legal_text_list_key.key_new_random() {
|
||||
let enc_attribute_legal_text_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"legal_text_list".to_owned(),
|
||||
enc_attribute_legal_text_list_key
|
||||
.enc_vec_string(self.meta_data.legal_text_list.clone()),
|
||||
enc_attribute_legal_text_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_legal_text_list);
|
||||
}
|
||||
|
||||
// key_list
|
||||
let mut enc_attribute_key_list_key =
|
||||
KeyEncryption::new(Some("key_list".to_owned()), None, None);
|
||||
if let Ok(_new) = enc_attribute_key_list_key.key_new_random() {
|
||||
let enc_attribute_key_list = PcdItemEncAttributeRoleConfidential::new(
|
||||
"key_list".to_owned(),
|
||||
enc_attribute_key_list_key.enc_vec_key_encryption(self.meta_data.key_list.clone()),
|
||||
enc_attribute_key_list_key,
|
||||
);
|
||||
enc_attribute_list.push(enc_attribute_key_list);
|
||||
}
|
||||
|
||||
return enc_attribute_list;
|
||||
}
|
||||
|
||||
// Additional
|
||||
}
|
||||
54
src/models/mod.rs
Normal file
54
src/models/mod.rs
Normal file
@ -0,0 +1,54 @@
|
||||
pub mod commit_method;
|
||||
pub mod condition_cap;
|
||||
pub mod condition_commit;
|
||||
pub mod condition_deposit;
|
||||
pub mod condition_orchestration;
|
||||
pub mod condition_Payments;
|
||||
pub mod condition_prd_address_set;
|
||||
pub mod condition_publish;
|
||||
pub mod deposit_method;
|
||||
pub mod item;
|
||||
pub mod item_artefact;
|
||||
pub mod item_commit;
|
||||
pub mod item_deposit;
|
||||
pub mod item_enum;
|
||||
pub mod item_Member;
|
||||
pub mod item_Payments;
|
||||
pub mod item_peer;
|
||||
pub mod item_process;
|
||||
pub mod key_encryption;
|
||||
pub mod `Envelope` ;
|
||||
pub mod `Envelope` _client;
|
||||
pub mod `Envelope` _connect;
|
||||
pub mod metadata;
|
||||
pub mod metadata_contract_public;
|
||||
pub mod metadata_private;
|
||||
pub mod metadata_role_confidential;
|
||||
pub mod pagination;
|
||||
pub mod Payments_method;
|
||||
pub mod pcd_item_enc;
|
||||
pub mod pcd_item_enc_attribute_private;
|
||||
pub mod pcd_item_enc_attribute_public;
|
||||
pub mod pcd_item_enc_attribute_role_confidential;
|
||||
pub mod pcd_item_generic_enc;
|
||||
pub mod request;
|
||||
pub mod request_pcd;
|
||||
pub mod request_prd;
|
||||
pub mod request_prd_confirm;
|
||||
pub mod request_prd_key_backup;
|
||||
pub mod request_prd_key_hello;
|
||||
pub mod request_prd_list;
|
||||
pub mod request_prd_message;
|
||||
pub mod request_prd_response;
|
||||
pub mod request_prd_update;
|
||||
pub mod role;
|
||||
pub mod role_artefact;
|
||||
pub mod role_commit;
|
||||
pub mod role_deposit;
|
||||
pub mod role_Member;
|
||||
pub mod role_Payments;
|
||||
pub mod role_peer;
|
||||
pub mod role_process;
|
||||
pub mod roles_group;
|
||||
pub mod shared_peer;
|
||||
pub mod shared_process;
|
||||
25
src/models/pagination.rs
Normal file
25
src/models/pagination.rs
Normal file
@ -0,0 +1,25 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Pagination {
|
||||
pub start: usize,
|
||||
pub number: usize,
|
||||
pub page_index: usize,
|
||||
}
|
||||
|
||||
impl Pagination {
|
||||
pub fn new(start: usize, number: usize, page_index: usize) -> Self {
|
||||
Pagination {
|
||||
start,
|
||||
number,
|
||||
page_index,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Pagination:");
|
||||
println!("Start: {}", self.start);
|
||||
println!("Number: {}", self.number);
|
||||
println!("Page Index: {}", self.page_index);
|
||||
}
|
||||
}
|
||||
8
src/models/payment_method.rs
Normal file
8
src/models/payment_method.rs
Normal file
@ -0,0 +1,8 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PaymentsMethod {
|
||||
pub method: String,
|
||||
}
|
||||
impl PaymentsMethod {}
|
||||
63
src/models/pcd_item_enc.rs
Normal file
63
src/models/pcd_item_enc.rs
Normal file
@ -0,0 +1,63 @@
|
||||
use std::hash::Hash;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PcdItemEnc {
|
||||
pub version: i64,
|
||||
pub item_type: String,
|
||||
pub name: String,
|
||||
pub pagination_number_per_pcd: u32,
|
||||
pub pcd_item_enc_attribute_public_list: Vec<PcdItemEncAttributePublic>,
|
||||
pub pcd_item_enc_attribute_role_confidential_list: Vec<PcdItemEncAttributeRoleConfidential>,
|
||||
pub pcd_item_enc_attribute_private_list: Vec<PcdItemEncAttributePrivate>,
|
||||
}
|
||||
|
||||
impl PcdItemEnc {
|
||||
pub fn new(
|
||||
version: i64,
|
||||
item_type: String,
|
||||
name: String,
|
||||
pagination_number_per_pcd: u32,
|
||||
pcd_item_enc_attribute_public_list: Vec<PcdItemEncAttributePublic>,
|
||||
pcd_item_enc_attribute_role_confidential_list: Vec<PcdItemEncAttributeRoleConfidential>,
|
||||
pcd_item_enc_attribute_private_list: Vec<PcdItemEncAttributePrivate>,
|
||||
) -> Self {
|
||||
PcdItemEnc {
|
||||
version,
|
||||
item_type,
|
||||
name,
|
||||
pagination_number_per_pcd,
|
||||
pcd_item_enc_attribute_public_list,
|
||||
pcd_item_enc_attribute_role_confidential_list,
|
||||
pcd_item_enc_attribute_private_list,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn display_info(&self) {
|
||||
println!("PcdItemEnc:");
|
||||
println!("Public Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_public_list {
|
||||
attr.display_info();
|
||||
}
|
||||
|
||||
println!("Role Confidential Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_role_confidential_list {
|
||||
attr.display_info();
|
||||
}
|
||||
|
||||
println!("Private Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_private_list {
|
||||
attr.display_info();
|
||||
}
|
||||
}
|
||||
|
||||
// Additional methods for PcdItemEnc can be added here
|
||||
}
|
||||
27
src/models/pcd_item_enc_attribute_private.rs
Normal file
27
src/models/pcd_item_enc_attribute_private.rs
Normal file
@ -0,0 +1,27 @@
|
||||
use std::hash::Hash;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PcdItemEncAttributePrivate {
|
||||
pub attribute_name: String,
|
||||
pub data_enc: String, // Assuming the encrypted data is represented as a String
|
||||
}
|
||||
|
||||
impl PcdItemEncAttributePrivate {
|
||||
pub fn new(attribute_name: String, data_enc: String) -> Self {
|
||||
PcdItemEncAttributePrivate {
|
||||
attribute_name,
|
||||
data_enc,
|
||||
}
|
||||
}
|
||||
// Method to display information
|
||||
pub fn display_info(&self) {
|
||||
println!("PcdItemEncAttributePrivate:");
|
||||
println!("Attribute Name: {}", self.attribute_name);
|
||||
println!("Data Enc: {}", self.data_enc);
|
||||
}
|
||||
|
||||
// Additional methods for PcdItemEncAttributePrivate can be added here
|
||||
}
|
||||
25
src/models/pcd_item_enc_attribute_public.rs
Normal file
25
src/models/pcd_item_enc_attribute_public.rs
Normal file
@ -0,0 +1,25 @@
|
||||
use std::hash::Hash;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PcdItemEncAttributePublic {
|
||||
pub attribute_name: String,
|
||||
pub data_enc: String, // Assuming the encrypted data is represented as a String
|
||||
}
|
||||
impl PcdItemEncAttributePublic {
|
||||
pub fn new(attribute_name: String, data_enc: String) -> Self {
|
||||
PcdItemEncAttributePublic {
|
||||
attribute_name,
|
||||
data_enc,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PcdItemEncAttributePublic:");
|
||||
println!("Attribute Name: {}", self.attribute_name);
|
||||
println!("Data Enc: {}", self.data_enc);
|
||||
}
|
||||
|
||||
// Additional methods for PcdItemEncAttributePublic can be added here
|
||||
}
|
||||
29
src/models/pcd_item_enc_attribute_role_confidential.rs
Normal file
29
src/models/pcd_item_enc_attribute_role_confidential.rs
Normal file
@ -0,0 +1,29 @@
|
||||
use std::hash::Hash;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::key_encryption::KeyEncryption;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PcdItemEncAttributeRoleConfidential {
|
||||
pub attribute_name: String,
|
||||
pub data_enc: String, // Assuming the encrypted data is represented as a String
|
||||
pub key: KeyEncryption, // Assuming the encrypted data is represented as a String
|
||||
}
|
||||
|
||||
impl PcdItemEncAttributeRoleConfidential {
|
||||
pub fn new(attribute_name: String, data_enc: String, key: KeyEncryption) -> Self {
|
||||
PcdItemEncAttributeRoleConfidential {
|
||||
attribute_name,
|
||||
data_enc,
|
||||
key,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("PcdItemEncAttributeRoleConfidential:");
|
||||
println!("Attribute Name: {}", self.attribute_name);
|
||||
println!("Data Enc: {}", self.data_enc);
|
||||
self.key.display_info();
|
||||
}
|
||||
}
|
||||
63
src/models/pcd_item_generic_enc.rs
Normal file
63
src/models/pcd_item_generic_enc.rs
Normal file
@ -0,0 +1,63 @@
|
||||
use std::hash::Hash;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
pcd_item_enc::PcdItemEnc, pcd_item_enc_attribute_private::PcdItemEncAttributePrivate,
|
||||
pcd_item_enc_attribute_public::PcdItemEncAttributePublic,
|
||||
pcd_item_enc_attribute_role_confidential::PcdItemEncAttributeRoleConfidential,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PcdItemGenericEnc {
|
||||
pub item_enc: PcdItemEnc,
|
||||
pub pcd_item_enc_attribute_public_list: Option<Vec<PcdItemEncAttributePublic>>,
|
||||
pub pcd_item_enc_attribute_role_confidential_list:
|
||||
Option<Vec<PcdItemEncAttributeRoleConfidential>>,
|
||||
pub pcd_item_enc_attribute_private_list: Option<Vec<PcdItemEncAttributePrivate>>,
|
||||
}
|
||||
|
||||
impl PcdItemGenericEnc {
|
||||
pub fn new(
|
||||
item_enc: PcdItemEnc,
|
||||
pcd_item_enc_attribute_public_list: Option<Vec<PcdItemEncAttributePublic>>,
|
||||
pcd_item_enc_attribute_role_confidential_list: Option<
|
||||
Vec<PcdItemEncAttributeRoleConfidential>,
|
||||
>,
|
||||
pcd_item_enc_attribute_private_list: Option<Vec<PcdItemEncAttributePrivate>>,
|
||||
) -> Self {
|
||||
PcdItemGenericEnc {
|
||||
item_enc,
|
||||
pcd_item_enc_attribute_public_list,
|
||||
pcd_item_enc_attribute_role_confidential_list,
|
||||
pcd_item_enc_attribute_private_list,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn display_info(&self) {
|
||||
println!("PcdItemEnc:");
|
||||
println!("Public Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_public_list {
|
||||
for attr_sub in attr {
|
||||
attr_sub.display_info();
|
||||
}
|
||||
}
|
||||
|
||||
println!("Role Confidential Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_role_confidential_list {
|
||||
for attr_sub in attr {
|
||||
attr_sub.display_info();
|
||||
}
|
||||
}
|
||||
|
||||
println!("Private Attributes:");
|
||||
for attr in &self.pcd_item_enc_attribute_private_list {
|
||||
for attr_sub in attr {
|
||||
attr_sub.display_info();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Additional methods for PcdItemEnc can be added here
|
||||
}
|
||||
46
src/models/request.rs
Normal file
46
src/models/request.rs
Normal file
@ -0,0 +1,46 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Request {
|
||||
pub item_name: Option<String>,
|
||||
pub request_type: String, // `type` is a reserved keyword in Rust, renamed to `request_type`
|
||||
pub version: i64,
|
||||
pub process_hash: String,
|
||||
pub pcd_reference_hash: Option<String>,
|
||||
pub item_reference_hash: Option<String>,
|
||||
}
|
||||
|
||||
impl Request {
|
||||
pub fn new(
|
||||
item_name: Option<String>,
|
||||
request_type: String,
|
||||
version: i64,
|
||||
process_hash: String,
|
||||
pcd_reference_hash: Option<String>,
|
||||
item_reference_hash: Option<String>,
|
||||
) -> Self {
|
||||
let req = Request {
|
||||
item_name,
|
||||
request_type,
|
||||
version,
|
||||
process_hash,
|
||||
pcd_reference_hash,
|
||||
item_reference_hash,
|
||||
};
|
||||
return req;
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!(
|
||||
"Item Name: {}, Request Type: {}, Version: {}, Process Hash: {}, PCD Reference Hash: {}, Item Reference Hash: {}",
|
||||
self.item_name.as_ref().unwrap_or(&"None".to_string()),
|
||||
self.request_type,
|
||||
self.version,
|
||||
self.process_hash,
|
||||
self.pcd_reference_hash.as_ref().unwrap_or(&"None".to_string()),
|
||||
self.item_reference_hash.as_ref().unwrap_or(&"None".to_string()),
|
||||
)
|
||||
}
|
||||
}
|
||||
143
src/models/request_pcd.rs
Normal file
143
src/models/request_pcd.rs
Normal file
@ -0,0 +1,143 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
item_enum::ItemEnum, key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient,
|
||||
pagination::Pagination, pcd_item_generic_enc::PcdItemGenericEnc, request::Request,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct Pcd {
|
||||
pub request: Request, // Assuming Request is a predefined struct
|
||||
pub item_list: Vec<PcdItemGenericEnc>,
|
||||
pub pagination: Pagination, // Assuming Pagination is a predefined struct
|
||||
}
|
||||
|
||||
impl Pcd {
|
||||
pub const TYPE: &'static str = "pcd";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
item_list: Vec<ItemEnum>,
|
||||
pagination: Pagination,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
Member_private_enc_key: KeyEncryption,
|
||||
) -> Self {
|
||||
let request = Request::new(
|
||||
request_item_name,
|
||||
Self::TYPE.to_string(),
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
);
|
||||
|
||||
// TODO: encrypt item_list
|
||||
let mut item_enc_list: Vec<PcdItemGenericEnc> = Vec::new();
|
||||
|
||||
item_list.iter().for_each(|item| match item {
|
||||
ItemEnum::Process(item_process) => {
|
||||
let item_enc = item_process.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::Member(item_Member) => {
|
||||
let item_enc = item_Member.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::Artefact(item_artefact) => {
|
||||
let item_enc = item_artefact.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::Peer(item_peer) => {
|
||||
let item_enc = item_peer.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::Payments(item_Payments) => {
|
||||
let item_enc = item_Payments.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::Deposit(item_deposit) => {
|
||||
let item_enc = item_deposit.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
ItemEnum::commit(item_commit) => {
|
||||
let item_enc = item_commit.enc(
|
||||
process_public_enc_key.clone(),
|
||||
Member_private_enc_key.clone(),
|
||||
);
|
||||
item_enc_list.push(item_enc);
|
||||
}
|
||||
});
|
||||
|
||||
Pcd {
|
||||
request,
|
||||
item_list: item_enc_list,
|
||||
pagination,
|
||||
}
|
||||
}
|
||||
pub fn display_info(&self) {
|
||||
println!("Pcd:");
|
||||
println!("Request:");
|
||||
self.request.display_info();
|
||||
|
||||
println!("Item List:");
|
||||
for item in &self.item_list {
|
||||
item.display_info();
|
||||
}
|
||||
|
||||
println!("Pagination:");
|
||||
self.pagination.display_info();
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key.enc_pcd(self.clone()).to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
}
|
||||
108
src/models/request_prd.rs
Normal file
108
src/models/request_prd.rs
Normal file
@ -0,0 +1,108 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
use std::hash::Hash;
|
||||
|
||||
use super::{key_encryption::KeyEncryption, request::Request};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct KeyRoleConfidential {
|
||||
pub attribute_name: String,
|
||||
pub key: KeyEncryption,
|
||||
pub algorithm_name: String,
|
||||
}
|
||||
|
||||
impl KeyRoleConfidential {
|
||||
pub fn new(attribute_name: String, key: KeyEncryption, algorithm_name: String) -> Self {
|
||||
KeyRoleConfidential {
|
||||
attribute_name,
|
||||
key,
|
||||
algorithm_name,
|
||||
}
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!(
|
||||
"Attribute Name: {}, Key: {:?}, Algorithm: {}",
|
||||
self.attribute_name,
|
||||
self.key, // Utilise {:?} si KeyEncryption implémente Debug
|
||||
self.algorithm_name
|
||||
)
|
||||
}
|
||||
|
||||
// Additional methods for KeyRoleConfidential can be added here
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
pub struct Prd {
|
||||
pub request: Request, // Assuming Request is a predefined struct
|
||||
pub pcd_keys_role_confidential_list_confidential: String,
|
||||
pub `Envelope` _public: Option<String>,
|
||||
pub `Envelope` _confidential: Option<String>,
|
||||
pub `Envelope` _private: Option<String>,
|
||||
pub sp_address_to: String,
|
||||
pub sp_address_from: String,
|
||||
pub sp_address_reply: String,
|
||||
pub timestamp_declared: u64, // Assuming a Unix timestamp
|
||||
pub role_name_from: String,
|
||||
pub role_name_to: String,
|
||||
}
|
||||
|
||||
impl Prd {
|
||||
pub const TYPE: &'static str = "prd";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_type: String,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
) -> Self {
|
||||
let request = Request::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
);
|
||||
Prd {
|
||||
request,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
}
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!(
|
||||
"Request: {:?}, PCD Keys Role Confidential: {:?}, `Envelope` Public: {}, `Envelope` Confidential: {}, `Envelope` Private: {}, SP Address From: {}, SP Address Reply: {}, Timestamp Declared: {}, Role Name From: {}, Role Name To: {}",
|
||||
self.request,
|
||||
self.pcd_keys_role_confidential_list_confidential,
|
||||
self.message_public.as_ref().unwrap(),
|
||||
self.message_confidential.as_ref().unwrap(),
|
||||
self.message_private.as_ref().unwrap(),
|
||||
self.sp_address_from,
|
||||
self.sp_address_reply,
|
||||
self.timestamp_declared,
|
||||
self.role_name_from,
|
||||
self.role_name_to,
|
||||
)
|
||||
}
|
||||
}
|
||||
100
src/models/request_prd_confirm.rs
Normal file
100
src/models/request_prd_confirm.rs
Normal file
@ -0,0 +1,100 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient, request_prd::Prd,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PrdConfirm {
|
||||
pub prd: Prd,
|
||||
pub code_confirm_confidential: String,
|
||||
}
|
||||
|
||||
impl PrdConfirm {
|
||||
pub const TYPE: &'static str = "prd_confirm";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
code_confirm_confidential: String,
|
||||
) -> Self {
|
||||
let request_type = Self::TYPE.to_string();
|
||||
let prd = Prd::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
);
|
||||
PrdConfirm {
|
||||
prd,
|
||||
code_confirm_confidential,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key
|
||||
.enc_prd_confirm(self.clone())
|
||||
.to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
// display_info method
|
||||
pub fn display_info(&self) {
|
||||
println!("PrdConfirm:");
|
||||
println!("PRD:");
|
||||
self.prd.display_info(); // Display information of Prd
|
||||
println!(
|
||||
"Code Confirm (Encrypted by Shared Secret): {}",
|
||||
self.code_confirm_confidential
|
||||
);
|
||||
}
|
||||
}
|
||||
108
src/models/request_prd_key_backup.rs
Normal file
108
src/models/request_prd_key_backup.rs
Normal file
@ -0,0 +1,108 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient, request_prd::Prd,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PrdKeyBackup {
|
||||
pub prd: Prd,
|
||||
pub device_footprint_enc_by_sp_shared_secret: String,
|
||||
pub part_1_enc_hash_enc_by_sp_shared_secret: String,
|
||||
pub shard_enc_by_sp_shared_secret: String,
|
||||
}
|
||||
|
||||
impl PrdKeyBackup {
|
||||
pub const TYPE: &'static str = "prd_key_backup";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
|
||||
device_footprint_enc_by_sp_shared_secret: String,
|
||||
part_1_enc_hash_enc_by_sp_shared_secret: String,
|
||||
shard_enc_by_sp_shared_secret: String,
|
||||
) -> Self {
|
||||
let request_type = Self::TYPE.to_string();
|
||||
let prd = Prd::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
);
|
||||
PrdKeyBackup {
|
||||
prd,
|
||||
device_footprint_enc_by_sp_shared_secret,
|
||||
part_1_enc_hash_enc_by_sp_shared_secret,
|
||||
shard_enc_by_sp_shared_secret,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key
|
||||
.enc_prd_key_backup(self.clone())
|
||||
.to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!(
|
||||
"PRD: {:?}, Device Footprint Encrypted: {}, Part 1 Encrypted Hash: {}, Shard Encrypted: {}",
|
||||
self.prd,
|
||||
self.device_footprint_enc_by_sp_shared_secret,
|
||||
self.part_1_enc_hash_enc_by_sp_shared_secret,
|
||||
self.shard_enc_by_sp_shared_secret
|
||||
)
|
||||
}
|
||||
}
|
||||
98
src/models/request_prd_key_hello.rs
Normal file
98
src/models/request_prd_key_hello.rs
Normal file
@ -0,0 +1,98 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient, request_prd::Prd,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PrdKeyHello {
|
||||
pub prd: Prd,
|
||||
pub part_1_enc_hash_enc_by_sp_shared_secret: String,
|
||||
}
|
||||
|
||||
impl PrdKeyHello {
|
||||
pub const TYPE: &'static str = "prd_key_hello";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
part_1_enc_hash_enc_by_sp_shared_secret: String,
|
||||
) -> Self {
|
||||
let request_type = Self::TYPE.to_string();
|
||||
let prd = Prd::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
);
|
||||
PrdKeyHello {
|
||||
prd,
|
||||
part_1_enc_hash_enc_by_sp_shared_secret,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key
|
||||
.enc_prd_key_hello(self.clone())
|
||||
.to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!(
|
||||
"PRD: {:?}, Part 1 Encrypted Hash: {}",
|
||||
self.prd, self.part_1_enc_hash_enc_by_sp_shared_secret
|
||||
)
|
||||
}
|
||||
}
|
||||
90
src/models/request_prd_list.rs
Normal file
90
src/models/request_prd_list.rs
Normal file
@ -0,0 +1,90 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient, request_prd::Prd,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PrdList {
|
||||
pub prd: Prd,
|
||||
}
|
||||
|
||||
impl PrdList {
|
||||
pub const TYPE: &'static str = "prd_list";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
) -> Self {
|
||||
let request_type = Self::TYPE.to_string();
|
||||
let prd = Prd::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
);
|
||||
PrdList { prd }
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key
|
||||
.enc_prd_list(self.clone())
|
||||
.to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!("PRD: {:?}", self.prd)
|
||||
}
|
||||
}
|
||||
89
src/models/request_prd_message.rs
Normal file
89
src/models/request_prd_message.rs
Normal file
@ -0,0 +1,89 @@
|
||||
use std::{
|
||||
collections::hash_map::DefaultHasher,
|
||||
hash::{Hash, Hasher},
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::{
|
||||
key_encryption::KeyEncryption, `Envelope` _client::EnvelopeClient, request_prd::Prd,
|
||||
shared_peer::Peer, shared_process::Process,
|
||||
};
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct PrdMessage {
|
||||
pub prd: Prd,
|
||||
}
|
||||
|
||||
impl PrdMessage {
|
||||
pub const TYPE: &'static str = "prd_message";
|
||||
pub fn new(
|
||||
request_item_name: Option<String>,
|
||||
request_version: i64,
|
||||
request_process_hash: String,
|
||||
request_pcd_reference_hash: Option<String>,
|
||||
request_item_reference_hash: Option<String>,
|
||||
pcd_keys_role_confidential_list_confidential: String,
|
||||
`Envelope` _public: Option<String>,
|
||||
`Envelope` _confidential: Option<String>,
|
||||
`Envelope` _private: Option<String>,
|
||||
sp_address_to: String,
|
||||
sp_address_from: String,
|
||||
sp_address_reply: String,
|
||||
timestamp_declared: u64,
|
||||
role_name_from: String,
|
||||
role_name_to: String,
|
||||
) -> Self {
|
||||
let request_type = Self::TYPE.to_string();
|
||||
let prd = Prd::new(
|
||||
request_item_name,
|
||||
request_type,
|
||||
request_version,
|
||||
request_process_hash,
|
||||
request_pcd_reference_hash,
|
||||
request_item_reference_hash,
|
||||
pcd_keys_role_confidential_list_confidential,
|
||||
`Envelope` _public,
|
||||
`Envelope` _confidential,
|
||||
`Envelope` _private,
|
||||
sp_address_to,
|
||||
sp_address_from,
|
||||
sp_address_reply,
|
||||
timestamp_declared,
|
||||
role_name_from,
|
||||
role_name_to,
|
||||
);
|
||||
PrdMessage { prd }
|
||||
}
|
||||
|
||||
pub fn to_message(
|
||||
&self,
|
||||
process_public_enc_key: KeyEncryption,
|
||||
`Envelope` _shared_peer_list: Vec<Peer>,
|
||||
`Envelope` _shared_process_list: Vec<Process>,
|
||||
`Envelope` _faucet_sp_address: String,
|
||||
pow_pathern: String,
|
||||
pow_difficulty: usize,
|
||||
) -> `Envelope` Client {
|
||||
let mut hasher: DefaultHasher = DefaultHasher::new();
|
||||
self.hash(&mut hasher);
|
||||
let request_hash = hasher.finish().to_string();
|
||||
let request_enc: String = process_public_enc_key
|
||||
.enc_prd_message(self.clone())
|
||||
.to_string();
|
||||
|
||||
`Envelope` Client::new(
|
||||
request_enc,
|
||||
request_hash,
|
||||
`Envelope` _shared_peer_list,
|
||||
`Envelope` _shared_process_list,
|
||||
`Envelope` _faucet_sp_address,
|
||||
pow_pathern,
|
||||
pow_difficulty,
|
||||
)
|
||||
}
|
||||
// Fonction pour afficher ou retourner les informations
|
||||
pub fn display_info(&self) -> String {
|
||||
format!("PRD: {:?}", self.prd)
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user