Compare commits
288 Commits
main
...
docker-sup
Author | SHA1 | Date | |
---|---|---|---|
![]() |
09594ba743 | ||
![]() |
fd259d596a | ||
![]() |
3e3716411b | ||
![]() |
a17b723081 | ||
![]() |
694bc71714 | ||
![]() |
e98c5e7073 | ||
![]() |
16cc47838e | ||
![]() |
4e7268c999 | ||
7793a2c909 | |||
a1a2825c9b | |||
![]() |
0061e80950 | ||
![]() |
e3083a99b9 | ||
![]() |
b3a6c4fd34 | ||
![]() |
b7dae27ad0 | ||
![]() |
2bdff74ca4 | ||
![]() |
0a0f47b0dc | ||
![]() |
7534ad5c72 | ||
92e50fe942 | |||
3362223cf6 | |||
413dadb17b | |||
7d0e2611de | |||
729120e7bc | |||
![]() |
a4c2fd2090 | ||
![]() |
362d2d6328 | ||
![]() |
35cf0285fa | ||
![]() |
21fb275739 | ||
![]() |
e2369eaf6f | ||
![]() |
684b71e00c | ||
![]() |
1e73a9aa1d | ||
![]() |
ab8d556ad7 | ||
![]() |
9a5ce7f5e2 | ||
![]() |
e77d27e0e4 | ||
![]() |
a7de9b1107 | ||
![]() |
b5ac0584ed | ||
![]() |
4ce434d642 | ||
![]() |
e0bc9e9036 | ||
![]() |
b14a37a32a | ||
![]() |
14603debb2 | ||
![]() |
b52468e987 | ||
![]() |
d55855710d | ||
![]() |
af3f1879f9 | ||
![]() |
8ab1a7db71 | ||
92c777dbef | |||
![]() |
1c159806d9 | ||
![]() |
e5802d2855 | ||
![]() |
3c89b0fb7f | ||
![]() |
dd6d93cd34 | ||
41b288eed6 | |||
58730c48f4 | |||
a3cf2517b3 | |||
f4baef4145 | |||
d256ac7074 | |||
7264e64a4a | |||
204211f3a3 | |||
304b1d0cc9 | |||
e05929ace1 | |||
e7df62f9cd | |||
208449eb72 | |||
cded679f4f | |||
774d675d9c | |||
985e6dcdc9 | |||
d69d179439 | |||
ed78b370fc | |||
daff63113a | |||
0eaa4497d1 | |||
339b88c785 | |||
9293a3f5d1 | |||
d008101ea9 | |||
f89b79ab5e | |||
c3b24b754c | |||
3985896d91 | |||
a686870e08 | |||
0175c793bb | |||
78dfebd71a | |||
2d226392dc | |||
afc40b4395 | |||
491f260374 | |||
d2a3147120 | |||
614849db78 | |||
0ecf627bf8 | |||
e421b5d7d9 | |||
6c65a6d184 | |||
ee2fddbd4f | |||
a85551773b | |||
f69fc1587e | |||
77618c4061 | |||
f762fb903c | |||
f246b5f039 | |||
dd13423c2b | |||
818e4d2152 | |||
df5d40ce96 | |||
b71e3f7525 | |||
b5bd076f1e | |||
4429564974 | |||
786ea94623 | |||
d8f6915a4a | |||
7babbc2a74 | |||
4d9b03ff18 | |||
6f786c5cc9 | |||
e5024ff019 | |||
bd8ae9183a | |||
8c5b2701fa | |||
506d62d1d3 | |||
fe6d78fbb6 | |||
978ebd75c1 | |||
2837fb6939 | |||
f74c9a324b | |||
3cf653c280 | |||
4bcf31d311 | |||
dc77482cc6 | |||
131ee8c55b | |||
17ad1a0319 | |||
855cd948ef | |||
5fc2764bbf | |||
f0db7a1f23 | |||
1fe174190f | |||
4c0a034a16 | |||
1bc61f9251 | |||
4be53916b0 | |||
079156d86a | |||
a4a81f42f1 | |||
51531a0f44 | |||
12705aa737 | |||
57a196d3ed | |||
b8a3042131 | |||
c5a00aa845 | |||
35a046f7e8 | |||
0a6bc4e970 | |||
cd1ab95a94 | |||
09b0f7a794 | |||
228ad8c0ec | |||
4f9775526e | |||
a628da9e2a | |||
57ce288ca4 | |||
b6ffebf6c0 | |||
13957e3e1f | |||
8f1b4a9071 | |||
326eb56b62 | |||
26495e973e | |||
![]() |
ac17d28f08 | ||
![]() |
0be1065c5e | ||
![]() |
27ee79f31d | ||
![]() |
123c6946f2 | ||
![]() |
1e8a51f37a | ||
![]() |
8a682b0a7c | ||
![]() |
95451b517e | ||
![]() |
58578450f3 | ||
![]() |
fff051b12c | ||
![]() |
8a5beeacc7 | ||
![]() |
e0647610db | ||
![]() |
d2d586f996 | ||
![]() |
2db9b29e6b | ||
![]() |
5be3340aad | ||
![]() |
1068340c09 | ||
![]() |
0f47588e8d | ||
![]() |
1789f95761 | ||
![]() |
2e8652453d | ||
![]() |
adc1fbfabd | ||
![]() |
103586570f | ||
![]() |
348e509ddc | ||
![]() |
adeb5e6537 | ||
![]() |
f409671d3a | ||
![]() |
46625984f3 | ||
![]() |
1619222fb3 | ||
![]() |
baaee6d31d | ||
![]() |
a2b969b72e | ||
![]() |
e47059668d | ||
![]() |
72a3230952 | ||
![]() |
a786eb8fe0 | ||
![]() |
614bdcedd2 | ||
![]() |
e2d8e0eb77 | ||
![]() |
da4c752df0 | ||
![]() |
0ad63d347b | ||
![]() |
b38189beca | ||
![]() |
64908496eb | ||
![]() |
2c5ed2c94a | ||
![]() |
541ad36d13 | ||
![]() |
eda2dd687d | ||
![]() |
391ca02186 | ||
![]() |
43459fa0bb | ||
![]() |
2fadc2e39c | ||
![]() |
d19abaf653 | ||
![]() |
00327b2e46 | ||
![]() |
0fc6a2a939 | ||
![]() |
d459d608ed | ||
![]() |
8845942f32 | ||
![]() |
49c125f085 | ||
![]() |
d10382f121 | ||
![]() |
06f3485361 | ||
![]() |
4e7dd4e0b4 | ||
![]() |
c2fde13e95 | ||
![]() |
4885066bd2 | ||
![]() |
ae807c3857 | ||
![]() |
12da1740e2 | ||
![]() |
b858c68ae0 | ||
![]() |
c3a7a3570b | ||
![]() |
9c9e50bcdb | ||
![]() |
c191d53769 | ||
![]() |
a84d1d0508 | ||
![]() |
b2ad5ee227 | ||
![]() |
d275fc5bc0 | ||
![]() |
838149982e | ||
![]() |
ccd5e398b0 | ||
775119cdf6 | |||
![]() |
9fd463b592 | ||
![]() |
4eda758b64 | ||
![]() |
ef556fddaa | ||
![]() |
aa14c69bdf | ||
![]() |
21dccde051 | ||
![]() |
4744740303 | ||
![]() |
7a4344608e | ||
![]() |
3c15b41699 | ||
![]() |
4809459da5 | ||
![]() |
3f633cf594 | ||
![]() |
9ff9176498 | ||
![]() |
1d9a994543 | ||
![]() |
3ebf4f7899 | ||
![]() |
319da6b1a3 | ||
![]() |
70bd927077 | ||
![]() |
432dc4b8ea | ||
![]() |
185a014de1 | ||
![]() |
9632ef24e3 | ||
![]() |
8d4238f531 | ||
![]() |
bb82a0b760 | ||
![]() |
d91a4a67eb | ||
![]() |
15eda2c4b1 | ||
![]() |
f3ab3525a3 | ||
![]() |
959f8a3058 | ||
![]() |
f3aa1bc2d0 | ||
![]() |
62b2137c77 | ||
![]() |
bbc9eaa962 | ||
![]() |
3cbe77c143 | ||
![]() |
97df8ea13d | ||
![]() |
0ea4c5f118 | ||
![]() |
665d95554d | ||
![]() |
b2c070642e | ||
![]() |
8688b6ed79 | ||
![]() |
dd797bd981 | ||
![]() |
95ed1e1f1c | ||
![]() |
41743ab3e7 | ||
![]() |
d61b210dda | ||
![]() |
38fa6e6239 | ||
![]() |
9017f7651b | ||
![]() |
d871b326c8 | ||
![]() |
b5881d63b0 | ||
![]() |
f59dc042b6 | ||
![]() |
e1f70cf849 | ||
![]() |
9087e0a535 | ||
![]() |
207e2d1d73 | ||
![]() |
a1cfba63ff | ||
![]() |
b648ed9ada | ||
![]() |
3d30eb8ce3 | ||
![]() |
cc45650777 | ||
e6007ca0a7 | |||
ef55bcea5e | |||
![]() |
c1b95290bf | ||
![]() |
b69fbdbd4c | ||
![]() |
31e955677e | ||
![]() |
53b12127ed | ||
![]() |
77ed38090f | ||
![]() |
71c616cec1 | ||
![]() |
da3829509d | ||
![]() |
d82a1c7624 | ||
![]() |
f52dca8db7 | ||
![]() |
0c38e24f44 | ||
![]() |
70bc03da9e | ||
![]() |
6492952dc0 | ||
![]() |
72089b8545 | ||
![]() |
c5ff2e2edb | ||
![]() |
87ee8ac40c | ||
![]() |
9fe3e7b499 | ||
![]() |
f5cdb7e2f1 | ||
![]() |
1f8da7ea61 | ||
![]() |
0e88a729c3 | ||
![]() |
d7daf72da0 | ||
![]() |
bd09245713 | ||
![]() |
6bf80eb0a5 | ||
![]() |
62d135925e | ||
![]() |
a55760c944 | ||
![]() |
932dc0ba55 | ||
![]() |
a59c680d0e | ||
![]() |
b1bfe0ba22 | ||
![]() |
9a34a02063 | ||
![]() |
8f11111943 | ||
![]() |
d24401ada8 | ||
![]() |
76dd12aaac | ||
![]() |
3dff792218 | ||
![]() |
0a7b289087 |
11
.cursor/.cursorignore
Normal file
11
.cursor/.cursorignore
Normal file
@ -0,0 +1,11 @@
|
||||
# Ignorer les sorties volumineuses ou non pertinentes pour le contexte IA
|
||||
archive/**
|
||||
tests/logs/**
|
||||
tests/reports/**
|
||||
node_modules/**
|
||||
dist/**
|
||||
build/**
|
||||
.tmp/**
|
||||
.cache/**#
|
||||
.env
|
||||
.env.*
|
32
.cursor/rules/00-foundations.mdc
Normal file
32
.cursor/rules/00-foundations.mdc
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
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/**.
|
17
.cursor/rules/05-template-governance.mdc
Normal file
17
.cursor/rules/05-template-governance.mdc
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Gouvernance du template 4NK
|
||||
|
||||
[portée]
|
||||
Assurer que chaque projet adapte intelligemment le template et que les améliorations génériques reviennent dans `4NK_template`.
|
||||
|
||||
[directives]
|
||||
- Conserver `security-audit` et `release-guard` dans tous projets.
|
||||
- Adapter la CI, les docs et `AGENTS.md` au contexte local.
|
||||
- En cas d'amélioration générique : ouvrir une issue "Template Feedback", prototyper, valider CI, mettre à jour `CHANGELOG.md`/`TEMPLATE_VERSION`.
|
||||
|
||||
[validation]
|
||||
- Refuser un push/tag si l'adaptation a retiré les vérifications minimales (sécurité, tests, build, version/changelog/tag).
|
||||
- Exiger une documentation claire dans `docs/TEMPLATE_ADAPTATION.md` et `docs/TEMPLATE_FEEDBACK.md`.
|
72
.cursor/rules/10-project-structure.mdc
Normal file
72
.cursor/rules/10-project-structure.mdc
Normal file
@ -0,0 +1,72 @@
|
||||
---
|
||||
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.
|
||||
|
33
.cursor/rules/20-documentation.mdc
Normal file
33
.cursor/rules/20-documentation.mdc
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
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/**.
|
57
.cursor/rules/30-testing.mdc
Normal file
57
.cursor/rules/30-testing.mdc
Normal file
@ -0,0 +1,57 @@
|
||||
---
|
||||
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.
|
55
.cursor/rules/40-dependencies-and-build.mdc
Normal file
55
.cursor/rules/40-dependencies-and-build.mdc
Normal file
@ -0,0 +1,55 @@
|
||||
---
|
||||
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.
|
65
.cursor/rules/41-ssh-automation.mdc
Normal file
65
.cursor/rules/41-ssh-automation.mdc
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Automatisation SSH et scripts
|
||||
|
||||
[portée]
|
||||
Création, usage et vérification du dossier scripts/ et de ses trois scripts standards liés aux opérations SSH et CI.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir la présence de scripts/ avec auto-ssh-push.sh, init-ssh-env.sh, setup-ssh-ci.sh.
|
||||
- Encadrer l’usage de ces scripts (locaux et CI), la sécurité, l’idempotence et la traçabilité.
|
||||
- Documenter toute mise à jour dans docs/SSH_UPDATE.md et CHANGELOG.md.
|
||||
|
||||
[directives]
|
||||
|
||||
- Créer et maintenir `scripts/auto-ssh-push.sh`, `scripts/init-ssh-env.sh`, `scripts/setup-ssh-ci.sh`.
|
||||
- Exiger permissions d’exécution adaptées sur scripts/ (exécution locale et CI).
|
||||
- Interdire le stockage de clés privées ou secrets en clair dans le dépôt.
|
||||
- Utiliser des variables d’environnement et secrets CI pour toute donnée sensible.
|
||||
- Rendre chaque script idempotent et verbosable ; produire un code de sortie non-zéro en cas d’échec.
|
||||
- Tracer les opérations : consigner un résumé dans docs/SSH_UPDATE.md (objectif, variables requises, effets, points d’échec).
|
||||
- Ajouter un contrôle automatique dans la CI pour vérifier l’existence et l’exécutabilité de ces scripts.
|
||||
|
||||
[validations]
|
||||
|
||||
- Échec bloquant si un des trois scripts manque ou n’est pas exécutable.
|
||||
- Échec bloquant si docs/SSH_UPDATE.md n’est pas mis à jour lors d’une modification de scripts.
|
||||
- Échec bloquant si un secret attendu n’est pas fourni en CI.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- scripts/**, docs/SSH_UPDATE.md, .gitea/workflows/ci.yml, CHANGELOG.md, docs/CONFIGURATION.md.
|
||||
|
||||
# Automatisation SSH et scripts
|
||||
|
||||
[portée]
|
||||
Création, usage et vérification du dossier scripts/ et de ses trois scripts standards liés aux opérations SSH et CI.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir la présence de scripts/ avec auto-ssh-push.sh, init-ssh-env.sh, setup-ssh-ci.sh.
|
||||
- Encadrer l’usage de ces scripts (locaux et CI), la sécurité, l’idempotence et la traçabilité.
|
||||
- Documenter toute mise à jour dans docs/SSH_UPDATE.md et CHANGELOG.md.
|
||||
|
||||
[directives]
|
||||
|
||||
- Créer et maintenir `scripts/auto-ssh-push.sh`, `scripts/init-ssh-env.sh`, `scripts/setup-ssh-ci.sh`.
|
||||
- Exiger permissions d’exécution adaptées sur scripts/ (exécution locale et CI).
|
||||
- Interdire le stockage de clés privées ou secrets en clair dans le dépôt.
|
||||
- Utiliser des variables d’environnement et secrets CI pour toute donnée sensible.
|
||||
- Rendre chaque script idempotent et verbosable ; produire un code de sortie non-zéro en cas d’échec.
|
||||
- Tracer les opérations : consigner un résumé dans docs/SSH_UPDATE.md (objectif, variables requises, effets, points d’échec).
|
||||
- Ajouter un contrôle automatique dans la CI pour vérifier l’existence et l’exécutabilité de ces scripts.
|
||||
|
||||
[validations]
|
||||
|
||||
- Échec bloquant si un des trois scripts manque ou n’est pas exécutable.
|
||||
- Échec bloquant si docs/SSH_UPDATE.md n’est pas mis à jour lors d’une modification de scripts.
|
||||
- Échec bloquant si un secret attendu n’est pas fourni en CI.
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- scripts/**, docs/SSH_UPDATE.md, .gitea/workflows/ci.yml, CHANGELOG.md, docs/CONFIGURATION.md.
|
53
.cursor/rules/42-template-sync.mdc
Normal file
53
.cursor/rules/42-template-sync.mdc
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Synchronisation de template (4NK)
|
||||
|
||||
[portée]
|
||||
Tous les projets issus de 4NK_project_template. Contrôle de l’alignement sur .cursor/, .gitea/, AGENTS.md, scripts/, docs/SSH_UPDATE.md.
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Garantir l’absence de dérive sur les éléments normatifs.
|
||||
- Exiger la mise à jour documentaire et du changelog à chaque synchronisation.
|
||||
- Bloquer la progression en cas d’intégrité non conforme.
|
||||
|
||||
[directives]
|
||||
- Lire la configuration de .4nk-sync.yml (source_repo, ref, paths, policy).
|
||||
- Refuser toute modification locale dans le périmètre des paths sans PR de synchronisation.
|
||||
- Après synchronisation : exiger mises à jour de CHANGELOG.md et docs/INDEX.md.
|
||||
- Scripts : vérifier présence, permissions d’exécution et absence de secrets en clair.
|
||||
- SSH : exiger mise à jour de docs/SSH_UPDATE.md si scripts/** modifié.
|
||||
|
||||
[validations]
|
||||
- Erreur bloquante si manifest_checksum manquant ou invalide.
|
||||
- Erreur bloquante si un path requis n’existe pas après sync.
|
||||
- Erreur bloquante si tests/CI signalent des scripts non exécutables ou des fichiers sensibles.
|
||||
|
||||
[artefacts concernés]
|
||||
- .4nk-sync.yml, TEMPLATE_VERSION, .cursor/**, .gitea/**, AGENTS.md, scripts/**, docs/SSH_UPDATE.md, CHANGELOG.md.
|
||||
# Synchronisation de template (4NK)
|
||||
|
||||
[portée]
|
||||
Tous les projets issus de 4NK_project_template. Contrôle de l’alignement sur .cursor/, .gitea/, AGENTS.md, scripts/, docs/SSH_UPDATE.md.
|
||||
|
||||
[objectifs]
|
||||
- Garantir l’absence de dérive sur les éléments normatifs.
|
||||
- Exiger la mise à jour documentaire et du changelog à chaque synchronisation.
|
||||
- Bloquer la progression en cas d’intégrité non conforme.
|
||||
|
||||
[directives]
|
||||
- Lire la configuration de .4nk-sync.yml (source_repo, ref, paths, policy).
|
||||
- Refuser toute modification locale dans le périmètre des paths sans PR de synchronisation.
|
||||
- Après synchronisation : exiger mises à jour de CHANGELOG.md et docs/INDEX.md.
|
||||
- Scripts : vérifier présence, permissions d’exécution et absence de secrets en clair.
|
||||
- SSH : exiger mise à jour de docs/SSH_UPDATE.md si scripts/** modifié.
|
||||
|
||||
[validations]
|
||||
- Erreur bloquante si manifest_checksum manquant ou invalide.
|
||||
- Erreur bloquante si un path requis n’existe pas après sync.
|
||||
- Erreur bloquante si tests/CI signalent des scripts non exécutables ou des fichiers sensibles.
|
||||
|
||||
[artefacts concernés]
|
||||
- .4nk-sync.yml, TEMPLATE_VERSION, .cursor/**, .gitea/**, AGENTS.md, scripts/**, docs/SSH_UPDATE.md, CHANGELOG.md.
|
156
.cursor/rules/4nkrules.mdc
Normal file
156
.cursor/rules/4nkrules.mdc
Normal file
@ -0,0 +1,156 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
# cursor.mcd — règles d’or 4NK
|
||||
language: fr
|
||||
policies:
|
||||
respond_in_french: true
|
||||
no_examples_in_codebase: true
|
||||
ask_before_push_or_tag: true
|
||||
|
||||
directories:
|
||||
ensure:
|
||||
- archive/
|
||||
- docs/
|
||||
- tests/
|
||||
- .gitea/
|
||||
docs:
|
||||
required_files:
|
||||
- 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
|
||||
tests:
|
||||
required_files:
|
||||
- cleanup.sh
|
||||
- README.md
|
||||
required_dirs:
|
||||
- connectivity
|
||||
- external
|
||||
- integration
|
||||
- logs
|
||||
- performance
|
||||
- reports
|
||||
- unit
|
||||
gitea:
|
||||
required_files:
|
||||
- PULL_REQUEST_TEMPLATE.md
|
||||
required_dirs:
|
||||
- ISSUE_TEMPLATE
|
||||
- workflows
|
||||
ISSUE_TEMPLATE:
|
||||
required_files:
|
||||
- bug_report.md
|
||||
- feature_request.md
|
||||
workflows:
|
||||
required_files:
|
||||
- ci.yml
|
||||
|
||||
files:
|
||||
required_root_files:
|
||||
- CHANGELOG.md
|
||||
- CODE_OF_CONDUCT.md
|
||||
- CONTRIBUTING.md
|
||||
- docker-compose.yml
|
||||
- LICENSE
|
||||
- README.md
|
||||
|
||||
documentation:
|
||||
update_on:
|
||||
- feature_added
|
||||
- feature_modified
|
||||
- feature_removed
|
||||
- feature_discovered
|
||||
replace_sections_named: ["RESUME"]
|
||||
rex_required_on_multiple_hypotheses: true
|
||||
archive_obsolete_docs: true
|
||||
|
||||
compilation:
|
||||
compile_often: true
|
||||
compile_when_needed: true
|
||||
fail_on_errors: true
|
||||
|
||||
problem_solving:
|
||||
auto_run_steps:
|
||||
- minimal_repro
|
||||
- inspect_logs
|
||||
- bisect_changes
|
||||
- form_hypotheses
|
||||
- targeted_tests
|
||||
- implement_fix
|
||||
- non_regression
|
||||
|
||||
office_docs:
|
||||
docx_reader: docx2txt
|
||||
fallback:
|
||||
- pandoc_convert
|
||||
- request_alternate_source
|
||||
|
||||
dependencies:
|
||||
auto_add_missing: true
|
||||
always_check_latest_stable: true
|
||||
document_changes_in_docs: true
|
||||
|
||||
csv_models:
|
||||
treat_as_source_of_truth: true
|
||||
multirow_headers_supported: true
|
||||
confirm_in_docs: true
|
||||
require_column_definitions: true
|
||||
|
||||
file_processing:
|
||||
study_each_file: true
|
||||
ask_questions_if_needed: true
|
||||
adapt_code_if_needed: true
|
||||
propose_solution_if_unreadable: true
|
||||
|
||||
types_and_properties:
|
||||
auto_correct_incoherences: true
|
||||
document_transformations: true
|
||||
|
||||
functional_consistency:
|
||||
always_ask_clarifying_questions: true
|
||||
|
||||
frontend_architecture:
|
||||
react_code_splitting: true
|
||||
state_management: ["redux", "context_api"]
|
||||
data_service_abstraction: true
|
||||
|
||||
execution_discipline:
|
||||
finish_started_work: true
|
||||
|
||||
open_source_and_gitea:
|
||||
prepare_every_project: true
|
||||
gitea_remote: "git.4nkweb.com"
|
||||
required_files:
|
||||
- LICENSE
|
||||
- CONTRIBUTING.md
|
||||
- CHANGELOG.md
|
||||
- CODE_OF_CONDUCT.md
|
||||
align_with_4NK_node_on_creation: true
|
||||
keep_alignment_updated: true
|
||||
|
||||
tests_and_docs:
|
||||
update_docs_and_tests_with_code: true
|
||||
require_green_tests_before_commit: true
|
||||
|
||||
versioning:
|
||||
manage_with_changelog: true
|
||||
confirm_before_push: true
|
||||
confirm_before_tag: true
|
||||
propose_semver_bump: true
|
||||
|
||||
pre_commit:
|
||||
run_all_tests: true
|
||||
block_on_errors: true
|
||||
|
||||
---
|
54
.cursor/rules/50-data-csv-models.mdc
Normal file
54
.cursor/rules/50-data-csv-models.mdc
Normal file
@ -0,0 +1,54 @@
|
||||
---
|
||||
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.
|
41
.cursor/rules/60-office-docs.mdc
Normal file
41
.cursor/rules/60-office-docs.mdc
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
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/**.
|
56
.cursor/rules/70-frontend-architecture.mdc
Normal file
56
.cursor/rules/70-frontend-architecture.mdc
Normal file
@ -0,0 +1,56 @@
|
||||
---
|
||||
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.
|
53
.cursor/rules/80-versioning-and-release.mdc
Normal file
53
.cursor/rules/80-versioning-and-release.mdc
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
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.
|
37
.cursor/rules/85-release-guard.mdc
Normal file
37
.cursor/rules/85-release-guard.mdc
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Garde de release: tests, documentation, compilation, version, changelog, tag
|
||||
|
||||
[portée]
|
||||
Contrôler systématiquement avant push/tag: tests verts, docs mises à jour, build OK, alignement numéro de version ↔ changelog ↔ tag git, mise à jour de déploiement, confirmation utilisateur (latest vs wip).
|
||||
|
||||
[objectifs]
|
||||
|
||||
- Empêcher toute publication sans vérifications minimales.
|
||||
- Exiger la cohérence sémantique (VERSION/TEMPLATE_VERSION ↔ CHANGELOG ↔ tag git).
|
||||
- Demander explicitement « latest » ou « wip » et appliquer la bonne stratégie.
|
||||
|
||||
[directives]
|
||||
|
||||
- Avant push/tag, exécuter: tests, compilation, lints (si configurés).
|
||||
- Mettre à jour la documentation et le changelog en conséquence.
|
||||
- Aligner le fichier de version (VERSION ou TEMPLATE_VERSION), l’entrée CHANGELOG et le tag.
|
||||
- Demander confirmation utilisateur: `latest` (release stable) ou `wip` (travail en cours).
|
||||
- latest: entrée datée dans CHANGELOG, version stable, tag `vX.Y.Z`.
|
||||
- wip: suffixe `-wip` recommandé dans version/tag (ex: `vX.Y.Z-wip.N`).
|
||||
- Mettre à jour le déploiement après publication (si pipeline défini), sinon documenter l’étape.
|
||||
|
||||
[validations]
|
||||
|
||||
- Refuser push/tag si:
|
||||
- tests/compilation échouent,
|
||||
- CHANGELOG non mis à jour,
|
||||
- VERSION/TEMPLATE_VERSION absent ou incohérent,
|
||||
- release type non fourni (ni latest, ni wip).
|
||||
|
||||
[artefacts concernés]
|
||||
|
||||
- CHANGELOG.md, VERSION ou TEMPLATE_VERSION, docs/**, .gitea/workflows/**, scripts/**.
|
||||
|
59
.cursor/rules/90-gitea-and-oss.mdc
Normal file
59
.cursor/rules/90-gitea-and-oss.mdc
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
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.
|
53
.cursor/rules/95-triage-and-problem-solving.mdc
Normal file
53
.cursor/rules/95-triage-and-problem-solving.mdc
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
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.
|
5
.cursor/rules/98-explain-complex-commands
Normal file
5
.cursor/rules/98-explain-complex-commands
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
quand tu fais une commande ou un requète complexe, explique là avant de la lancer
|
9
.cursor/rules/99-lint-markdow.mdc
Normal file
9
.cursor/rules/99-lint-markdow.mdc
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
description:
|
||||
globs:
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Lint
|
||||
|
||||
respecter strictement les règles de lint du markdown
|
16
.cursor/rules/ruleset-index.md
Normal file
16
.cursor/rules/ruleset-index.md
Normal file
@ -0,0 +1,16 @@
|
||||
# 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.
|
||||
- 85-release-guard.mdc : garde de release (tests/doc/build/version/changelog/tag; latest vs wip).
|
||||
- 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}
|
26
.cursorignore
Normal file
26
.cursorignore
Normal file
@ -0,0 +1,26 @@
|
||||
# Ignorer les contenus volumineux pour le contexte IA
|
||||
node_modules/
|
||||
dist/
|
||||
build/
|
||||
coverage/
|
||||
.cache/
|
||||
.tmp/
|
||||
.parcel-cache/
|
||||
|
||||
# Rapports et logs de tests
|
||||
tests/logs/
|
||||
tests/reports/
|
||||
|
||||
# Fichiers lourds
|
||||
**/*.map
|
||||
**/*.min.*
|
||||
**/*.wasm
|
||||
**/*.{png,jpg,jpeg,svg,ico,pdf}
|
||||
|
||||
# Ne pas ignorer .cursor ni AGENTS.md
|
||||
!/.cursor
|
||||
!/AGENTS.md
|
||||
|
||||
!.cursor/
|
||||
|
||||
!AGENTS.md
|
98
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
98
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
@ -0,0 +1,98 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Signaler un bug pour nous aider à améliorer sdk_common
|
||||
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 sdk_common** : [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 !** 🙏
|
||||
|
157
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
157
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
@ -0,0 +1,157 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Proposer une nouvelle fonctionnalité pour sdk_common
|
||||
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 sdk_common !** 🌟
|
||||
|
181
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
181
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
@ -0,0 +1,181 @@
|
||||
# Pull Request - sdk_common
|
||||
|
||||
## 📋 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 !** 🙏
|
||||
|
15
.gitea/workflows/LOCAL_OVERRIDES.yml
Normal file
15
.gitea/workflows/LOCAL_OVERRIDES.yml
Normal file
@ -0,0 +1,15 @@
|
||||
# LOCAL_OVERRIDES.yml — dérogations locales contrôlées
|
||||
overrides:
|
||||
- path: ".gitea/workflows/ci.yml"
|
||||
reason: "spécificité d’environnement"
|
||||
owner: "@maintainer_handle"
|
||||
expires: "2025-12-31"
|
||||
- path: "scripts/auto-ssh-push.sh"
|
||||
reason: "flux particulier temporaire"
|
||||
owner: "@maintainer_handle"
|
||||
expires: "2025-10-01"
|
||||
policy:
|
||||
allow_only_listed_paths: true
|
||||
require_expiry: true
|
||||
audit_in_ci: true
|
||||
|
486
.gitea/workflows/ci.yml
Normal file
486
.gitea/workflows/ci.yml
Normal file
@ -0,0 +1,486 @@
|
||||
name: CI - 4NK Node
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, develop ]
|
||||
tags:
|
||||
- 'v*'
|
||||
pull_request:
|
||||
branches: [ main, develop ]
|
||||
|
||||
env:
|
||||
RUST_VERSION: '1.70'
|
||||
DOCKER_COMPOSE_VERSION: '2.20.0'
|
||||
CI_SKIP: 'true'
|
||||
|
||||
jobs:
|
||||
# Job de vérification du code
|
||||
code-quality:
|
||||
name: Code Quality
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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
|
||||
|
||||
markdownlint:
|
||||
name: Markdown Lint
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Run markdownlint
|
||||
run: |
|
||||
npm --version || (curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && sudo apt-get install -y nodejs)
|
||||
npx -y markdownlint-cli@0.42.0 "**/*.md" --ignore "archive/**"
|
||||
|
||||
- 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"
|
||||
)
|
||||
|
||||
for file in "${required_files[@]}"; do
|
||||
if [[ ! -f "$file" ]]; then
|
||||
echo "Missing required documentation file: $file"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
bash-required:
|
||||
name: Bash Requirement
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Verify bash availability
|
||||
run: |
|
||||
if ! command -v bash >/dev/null 2>&1; then
|
||||
echo "bash is required for agents and scripts"; exit 1;
|
||||
fi
|
||||
- name: Verify agents runner exists
|
||||
run: |
|
||||
if [ ! -f scripts/agents/run.sh ]; then
|
||||
echo "scripts/agents/run.sh is missing"; exit 1;
|
||||
fi
|
||||
|
||||
agents-smoke:
|
||||
name: Agents Smoke (no AI)
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Ensure agents scripts executable
|
||||
run: |
|
||||
chmod +x scripts/agents/*.sh || true
|
||||
- name: Run agents without AI
|
||||
env:
|
||||
OPENAI_API_KEY: ""
|
||||
run: |
|
||||
scripts/agents/run.sh
|
||||
- name: Upload agents reports
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: agents-reports
|
||||
path: tests/reports/agents
|
||||
|
||||
openia-agents:
|
||||
name: Agents with OpenIA
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' && secrets.OPENAI_API_KEY != '' }}
|
||||
env:
|
||||
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
||||
OPENAI_MODEL: ${{ vars.OPENAI_MODEL }}
|
||||
OPENAI_API_BASE: ${{ vars.OPENAI_API_BASE }}
|
||||
OPENAI_TEMPERATURE: ${{ vars.OPENAI_TEMPERATURE }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Ensure agents scripts executable
|
||||
run: |
|
||||
chmod +x scripts/agents/*.sh || true
|
||||
- name: Run agents with AI
|
||||
run: |
|
||||
scripts/agents/run.sh
|
||||
- name: Upload agents reports
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: agents-reports-ai
|
||||
path: tests/reports/agents
|
||||
|
||||
deployment-checks:
|
||||
name: Deployment Checks
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Validate deployment documentation
|
||||
run: |
|
||||
if [ ! -f docs/DEPLOYMENT.md ]; then
|
||||
echo "Missing docs/DEPLOYMENT.md"; exit 1; fi
|
||||
if [ ! -f docs/SSH_UPDATE.md ]; then
|
||||
echo "Missing docs/SSH_UPDATE.md"; exit 1; fi
|
||||
- name: Ensure tests directories exist
|
||||
run: |
|
||||
mkdir -p tests/logs tests/reports || true
|
||||
echo "OK"
|
||||
|
||||
security-audit:
|
||||
name: Security Audit
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Ensure scripts executable
|
||||
run: |
|
||||
chmod +x scripts/security/audit.sh || true
|
||||
- name: Run template security audit
|
||||
run: |
|
||||
if [ -f scripts/security/audit.sh ]; then
|
||||
./scripts/security/audit.sh
|
||||
else
|
||||
echo "No security audit script (ok)"
|
||||
fi
|
||||
|
||||
# Job de release guard (cohérence release)
|
||||
release-guard:
|
||||
name: Release Guard
|
||||
runs-on: [self-hosted, linux]
|
||||
needs: [code-quality, unit-tests, documentation-tests, markdownlint, security-audit, deployment-checks, bash-required]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Ensure guard scripts are executable
|
||||
run: |
|
||||
chmod +x scripts/release/guard.sh || true
|
||||
chmod +x scripts/checks/version_alignment.sh || true
|
||||
|
||||
- name: Version alignment check
|
||||
run: |
|
||||
if [ -f scripts/checks/version_alignment.sh ]; then
|
||||
./scripts/checks/version_alignment.sh
|
||||
else
|
||||
echo "No version alignment script (ok)"
|
||||
fi
|
||||
|
||||
- name: Release guard (CI verify)
|
||||
env:
|
||||
RELEASE_TYPE: ci-verify
|
||||
run: |
|
||||
if [ -f scripts/release/guard.sh ]; then
|
||||
./scripts/release/guard.sh
|
||||
else
|
||||
echo "No guard script (ok)"
|
||||
fi
|
||||
|
||||
release-create:
|
||||
name: Create Release (Gitea API)
|
||||
runs-on: ubuntu-latest
|
||||
needs: [release-guard]
|
||||
if: ${{ env.CI_SKIP != 'true' && startsWith(github.ref, 'refs/tags/') }}
|
||||
env:
|
||||
RELEASE_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||
BASE_URL: ${{ vars.BASE_URL }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Validate token and publish release
|
||||
run: |
|
||||
set -e
|
||||
if [ -z "${RELEASE_TOKEN}" ]; then
|
||||
echo "RELEASE_TOKEN secret is missing" >&2; exit 1; fi
|
||||
if [ -z "${BASE_URL}" ]; then
|
||||
BASE_URL="https://git.4nkweb.com"; fi
|
||||
TAG="${GITHUB_REF##*/}"
|
||||
REPO="${GITHUB_REPOSITORY}"
|
||||
OWNER="${REPO%%/*}"
|
||||
NAME="${REPO##*/}"
|
||||
echo "Publishing release ${TAG} to ${BASE_URL}/${OWNER}/${NAME}"
|
||||
curl -sSf -X POST \
|
||||
-H "Authorization: token ${RELEASE_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\":\"${TAG}\",\"name\":\"${TAG}\",\"draft\":false,\"prerelease\":false}" \
|
||||
"${BASE_URL}/api/v1/repos/${OWNER}/${NAME}/releases" >/dev/null
|
||||
echo "Release created"
|
||||
|
||||
# Job de tests de performance
|
||||
performance-tests:
|
||||
name: Performance Tests
|
||||
runs-on: [self-hosted, linux]
|
||||
if: ${{ env.CI_SKIP != 'true' }}
|
||||
|
||||
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: [self-hosted, linux]
|
||||
needs: [code-quality, unit-tests, integration-tests, security-tests, docker-build, documentation-tests]
|
||||
if: ${{ env.CI_SKIP != 'true' && 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
|
350
.gitea/workflows/ci.yml.bak
Normal file
350
.gitea/workflows/ci.yml.bak
Normal file
@ -0,0 +1,350 @@
|
||||
name: CI - sdk_common
|
||||
|
||||
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: |
|
||||
cargo clippy --all-targets --all-features -- -D warnings
|
||||
|
||||
- name: Run rustfmt
|
||||
run: |
|
||||
cargo fmt --all -- --check
|
||||
|
||||
- name: Check documentation
|
||||
run: |
|
||||
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: |
|
||||
cargo test --lib --bins
|
||||
|
||||
- name: Run integration tests
|
||||
run: |
|
||||
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 crate Docker image
|
||||
run: |
|
||||
docker build -t sdk_common:build .
|
||||
|
||||
- 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: |
|
||||
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: |
|
||||
echo "Documentation checks completed"
|
||||
|
||||
security-audit:
|
||||
name: Security Audit
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
- name: Ensure scripts executable
|
||||
run: |
|
||||
chmod +x scripts/security/audit.sh || true
|
||||
- name: Run template security audit
|
||||
run: |
|
||||
if [ -f scripts/security/audit.sh ]; then
|
||||
./scripts/security/audit.sh
|
||||
else
|
||||
echo "No security audit script (ok)"
|
||||
fi
|
||||
|
||||
# Job de release guard (cohérence release)
|
||||
release-guard:
|
||||
name: Release Guard
|
||||
runs-on: ubuntu-latest
|
||||
needs: [code-quality, unit-tests, documentation-tests, security-audit]
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Ensure guard scripts are executable
|
||||
run: |
|
||||
chmod +x scripts/release/guard.sh || true
|
||||
chmod +x scripts/checks/version_alignment.sh || true
|
||||
|
||||
- name: Version alignment check
|
||||
run: |
|
||||
if [ -f scripts/checks/version_alignment.sh ]; then
|
||||
./scripts/checks/version_alignment.sh
|
||||
else
|
||||
echo "No version alignment script (ok)"
|
||||
fi
|
||||
|
||||
- name: Release guard (CI verify)
|
||||
env:
|
||||
RELEASE_TYPE: ci-verify
|
||||
run: |
|
||||
if [ -f scripts/release/guard.sh ]; then
|
||||
./scripts/release/guard.sh
|
||||
else
|
||||
echo "No guard script (ok)"
|
||||
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
|
40
.gitea/workflows/template-sync.yml
Normal file
40
.gitea/workflows/template-sync.yml
Normal file
@ -0,0 +1,40 @@
|
||||
# .gitea/workflows/template-sync.yml — synchronisation et contrôles d’intégrité
|
||||
name: 4NK Template Sync
|
||||
on:
|
||||
schedule: # planification régulière
|
||||
- cron: "0 4 * * 1" # exécution hebdomadaire (UTC)
|
||||
workflow_dispatch: {} # déclenchement manuel
|
||||
|
||||
jobs:
|
||||
check-and-sync:
|
||||
runs-on: linux
|
||||
steps:
|
||||
- name: Lire TEMPLATE_VERSION et .4nk-sync.yml
|
||||
# Doit charger ref courant, source_repo et périmètre paths
|
||||
|
||||
- name: Récupérer la version publiée du template/4NK_rules
|
||||
# Doit comparer TEMPLATE_VERSION avec ref amont
|
||||
|
||||
- name: Créer branche de synchronisation si divergence
|
||||
# Doit créer chore/template-sync-<date> et préparer un commit
|
||||
|
||||
- name: Synchroniser les chemins autoritatifs
|
||||
# Doit mettre à jour .cursor/**, .gitea/**, AGENTS.md, scripts/**, docs/SSH_UPDATE.md
|
||||
|
||||
- name: Contrôles post-sync (bloquants)
|
||||
# 1) Vérifier présence et exécutable des scripts/*.sh
|
||||
# 2) Vérifier mise à jour CHANGELOG.md et docs/INDEX.md
|
||||
# 3) Vérifier docs/SSH_UPDATE.md si scripts/** a changé
|
||||
# 4) Vérifier absence de secrets en clair dans scripts/**
|
||||
# 5) Vérifier manifest_checksum si publié
|
||||
|
||||
- name: Tests, lint, sécurité statique
|
||||
# Doit exiger un état vert
|
||||
|
||||
- name: Ouvrir PR de synchronisation
|
||||
# Titre: "[template-sync] chore: aligner .cursor/.gitea/AGENTS.md/scripts"
|
||||
# Doit inclure résumé des fichiers modifiés et la version appliquée
|
||||
|
||||
- name: Mettre à jour TEMPLATE_VERSION (dans PR)
|
||||
# Doit remplacer la valeur par la ref appliquée
|
||||
|
4
.gitignore
vendored
4
.gitignore
vendored
@ -33,3 +33,7 @@ doc/diagrams/.$PRDMessageFlows.drawio.bkp
|
||||
doc/diagrams/.$PRDResponse.drawio.bkp
|
||||
doc/diagrams/.$PRDUpdate.drawio.bkp
|
||||
doc/diagrams/.$PRDUpdateFlows.drawio.bkp
|
||||
|
||||
!.cursor/
|
||||
|
||||
!AGENTS.md
|
||||
|
14
.markdownlint.json
Normal file
14
.markdownlint.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"MD013": {
|
||||
"line_length": 200,
|
||||
"code_blocks": false,
|
||||
"tables": false,
|
||||
"headings": false
|
||||
},
|
||||
"MD007": {
|
||||
"indent": 2
|
||||
},
|
||||
"MD024": {
|
||||
"siblings_only": true
|
||||
}
|
||||
}
|
270
AGENTS.md
Normal file
270
AGENTS.md
Normal file
@ -0,0 +1,270 @@
|
||||
# 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.
|
||||
|
||||
---
|
||||
|
||||
### Agent Sécurité (Responsable)
|
||||
**Missions**
|
||||
- Orchestrer l’audit de sécurité automatisé via `scripts/security/audit.sh` (cargo audit, npm audit, scan de secrets).
|
||||
- Interdire l’introduction de secrets en clair; assurer la rotation des secrets CI.
|
||||
- Vérifier permissions et non‑exposition d’endpoints privés.
|
||||
- Bloquer la release si l’audit échoue (intégré au `release-guard`).
|
||||
|
||||
**Artefacts**
|
||||
- `scripts/security/audit.sh`, `.gitea/workflows/ci.yml` (job `security-audit`), `docs/SECURITY_AUDIT.md`, `SECURITY.md`.
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
229
CHANGELOG.md
Normal file
229
CHANGELOG.md
Normal file
@ -0,0 +1,229 @@
|
||||
# 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
|
||||
|
||||
### Changed
|
||||
|
||||
### Fixed
|
||||
|
||||
## [0.1.1] - 2025-08-26
|
||||
|
||||
### 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`.
|
||||
- Tests d’intégration Rust: `tests/smoke.rs`, `tests/error_mapping.rs`, `tests/special_roles.rs`; `tests/README.md`.
|
||||
|
||||
### Changed
|
||||
- Correction de liens internes dans `docs/COMMUNITY_GUIDE.md`.
|
||||
- Vérification et consolidation de `docs/INDEX.md`.
|
||||
- Mise à jour `docs/TESTING.md` pour référencer les tests Rust de la crate.
|
||||
|
||||
### 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)
|
93
CODE_OF_CONDUCT.md
Normal file
93
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,93 @@
|
||||
# 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
Normal file
372
CONTRIBUTING.md
Normal file
@ -0,0 +1,372 @@
|
||||
# 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 ! 🚀
|
39
Cargo.toml
39
Cargo.toml
@ -1,23 +1,34 @@
|
||||
[package]
|
||||
name = "sdk_common"
|
||||
version = "0.1.0"
|
||||
version = "0.1.1"
|
||||
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]
|
||||
wasm-bindgen = "0.2.90"
|
||||
serde = { version = "1.0.193", features = ["derive"] }
|
||||
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"] }
|
||||
anyhow = "1.0"
|
||||
env_logger = "0.9"
|
||||
log = "0.4.6"
|
||||
rand = "0.8.5"
|
||||
serde = { version = "1.0.193", features = ["derive"] }
|
||||
serde_json = { version = "1.0.108" }
|
||||
rs_merkle = "1.4.2"
|
||||
flate2 = { version = "1.0", features = ["miniz_oxide"] }
|
||||
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 }
|
||||
|
5
Dockerfile
Normal file
5
Dockerfile
Normal file
@ -0,0 +1,5 @@
|
||||
# Debian-based Rust builder for library/test
|
||||
FROM rust:1.70-bookworm AS build
|
||||
WORKDIR /app
|
||||
COPY . .
|
||||
RUN cargo build --release && cargo test --release
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
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.
|
227
README.md
227
README.md
@ -1,93 +1,202 @@
|
||||
# sdk_common
|
||||
# SDK Common
|
||||
|
||||
Bibliothèque commune pour l'écosystème 4NK, fournissant les types, structures et utilitaires partagés entre tous les modules SDK.
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
## Getting started
|
||||
SDK Common est le fondement de l'écosystème 4NK, fournissant :
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
- **Types de données** : Structures pour les processus, membres, règles de validation
|
||||
- **Sérialisation** : Support pour JSON et binaire avec compression
|
||||
- **Cryptographie** : Utilitaires pour les signatures et le chiffrement
|
||||
- **Compression** : Migration vers `flate2` pour la compatibilité WASM
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
## 🚀 Migration WASM
|
||||
|
||||
## Add your files
|
||||
### État actuel
|
||||
- ✅ **Migration flate2** : Remplacement de `zstd` par `flate2` pour la compatibilité WASM
|
||||
- ✅ **Compression DEFLATE** : Utilisation de `miniz_oxide` (pure Rust)
|
||||
- ✅ **Sérialisation** : Support JSON et binaire avec compression
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.4nkweb.com/4nk/sdk_common.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
### Changements récents
|
||||
```toml
|
||||
# Cargo.toml
|
||||
[dependencies]
|
||||
# zstd = "0.13.3" # ❌ Supprimé
|
||||
flate2 = { version = "1.0", features = ["miniz_oxide"] } # ✅ Ajouté
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
## 📦 Installation
|
||||
|
||||
- [ ] [Set up project integrations](https://git.4nkweb.com/4nk/sdk_common/-/settings/integrations)
|
||||
### Prérequis
|
||||
- Rust 1.70+
|
||||
- Cargo
|
||||
|
||||
## Collaborate with your team
|
||||
### Installation locale
|
||||
```bash
|
||||
git clone https://git.4nkweb.com/4nk/sdk_common.git
|
||||
cd sdk_common
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
- [ ] [Invite team Members and collaborators](https://docs.gitlab.com/ee/user/project/Members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
### Utilisation comme dépendance
|
||||
```toml
|
||||
[dependencies]
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", branch = "docker-support" }
|
||||
```
|
||||
|
||||
## Test and Deploy
|
||||
## 🔧 Utilisation
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
### Types de base
|
||||
```rust
|
||||
use sdk_common::{Process, Member, ValidationRule, ProcessState};
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
// Créer un processus
|
||||
let process = Process {
|
||||
id: "process_123".to_string(),
|
||||
name: "Mon Processus".to_string(),
|
||||
device_id: "device_456".to_string(),
|
||||
state: ProcessState::Active,
|
||||
// ...
|
||||
};
|
||||
```
|
||||
|
||||
***
|
||||
### Compression et sérialisation
|
||||
```rust
|
||||
use sdk_common::{compress_data, decompress_data};
|
||||
|
||||
# Editing this README
|
||||
// Compression avec flate2
|
||||
let data = b"données à compresser";
|
||||
let compressed = compress_data(data)?;
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
// Décompression
|
||||
let decompressed = decompress_data(&compressed)?;
|
||||
```
|
||||
|
||||
## Suggestions for a good README
|
||||
### Validation
|
||||
```rust
|
||||
use sdk_common::{ValidationRule, ValidationRuleType};
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
let rule = ValidationRule {
|
||||
id: "rule_1".to_string(),
|
||||
field_name: "amount".to_string(),
|
||||
rule_type: ValidationRuleType::Range,
|
||||
parameters: Some(json!({"min": 0, "max": 1000})),
|
||||
role_id: "admin".to_string(),
|
||||
};
|
||||
```
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
## 🧪 Tests
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
### Tests unitaires
|
||||
```bash
|
||||
cargo test
|
||||
```
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
### Tests d'intégration
|
||||
```bash
|
||||
cargo test --test integration_tests
|
||||
```
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
### Tests de compression
|
||||
```bash
|
||||
cargo test compression
|
||||
```
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
## 📚 Documentation
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
### Documentation API
|
||||
```bash
|
||||
cargo doc --open
|
||||
```
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
### Guides disponibles
|
||||
- [Architecture](docs/ARCHITECTURE.md) - Architecture détaillée
|
||||
- [API Reference](docs/API.md) - Documentation complète de l'API
|
||||
- [Configuration](docs/CONFIGURATION.md) - Guide de configuration
|
||||
- [Testing](docs/TESTING.md) - Stratégies de tests
|
||||
- [Security](docs/SECURITY.md) - Considérations de sécurité
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
## 🔄 Migration depuis zstd
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
### Changements dans le code
|
||||
```rust
|
||||
// Avant (zstd)
|
||||
use sdk_common::zstd;
|
||||
let compressed = zstd::encode_all(data, ZSTD_COMPRESSION_LEVEL)?;
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
// Après (flate2)
|
||||
use sdk_common::flate2;
|
||||
use flate2::write::DeflateEncoder;
|
||||
use flate2::Compression;
|
||||
let mut encoder = DeflateEncoder::new(Vec::new(), Compression::default());
|
||||
encoder.write_all(data)?;
|
||||
let compressed = encoder.finish()?;
|
||||
```
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
### Avantages de flate2
|
||||
- ✅ **Pure Rust** : Pas de dépendances C
|
||||
- ✅ **WASM compatible** : Compilation WebAssembly possible
|
||||
- ✅ **Performance** : Compression DEFLATE optimisée
|
||||
- ✅ **Maintenance** : Moins de dépendances externes
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
## 🤝 Contribution
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
### Prérequis
|
||||
- Rust 1.70+
|
||||
- Connaissance de l'écosystème 4NK
|
||||
- Tests pour toutes les nouvelles fonctionnalités
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
### Processus
|
||||
1. Fork du projet
|
||||
2. Créer une branche feature
|
||||
3. Développer avec tests
|
||||
4. Vérifier la compatibilité WASM
|
||||
5. Pull request vers `docker-support`
|
||||
|
||||
### Standards de code
|
||||
- Documentation RustDoc pour toutes les APIs publiques
|
||||
- Tests unitaires et d'intégration
|
||||
- Respect des conventions Rust
|
||||
- Validation WASM pour les nouvelles fonctionnalités
|
||||
|
||||
## 📋 Roadmap
|
||||
|
||||
### Phase 1 : Stabilisation (✅ Terminé)
|
||||
- [x] Migration vers flate2
|
||||
- [x] Tests de compression
|
||||
- [x] Documentation API
|
||||
|
||||
### Phase 2 : Optimisations (🔄 En cours)
|
||||
- [ ] Optimisation des performances
|
||||
- [ ] Support pour d'autres algorithmes de compression
|
||||
- [ ] Amélioration de la sérialisation
|
||||
|
||||
### Phase 3 : Extensions (⏳ Planifié)
|
||||
- [ ] Support pour les schémas de validation avancés
|
||||
- [ ] Intégration avec d'autres formats de données
|
||||
- [ ] Outils de migration automatique
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
- **Audit de sécurité** : Voir [SECURITY_AUDIT.md](docs/SECURITY_AUDIT.md)
|
||||
- **Vulnérabilités** : Signaler via [SECURITY.md](docs/SECURITY.md)
|
||||
- **Dépendances** : Mise à jour régulière des dépendances
|
||||
|
||||
## 📄 Licence
|
||||
|
||||
MIT License - voir [LICENSE](LICENSE) pour plus de détails.
|
||||
|
||||
## 🆘 Support
|
||||
|
||||
- **Documentation** : [docs/](docs/)
|
||||
- **Issues** : [GitLab Issues](https://git.4nkweb.com/4nk/sdk_common/-/issues)
|
||||
- **Discussions** : [GitLab Discussions](https://git.4nkweb.com/4nk/sdk_common/-/issues)
|
||||
|
||||
## 📊 Statut du projet
|
||||
|
||||
- **Version** : 0.1.1
|
||||
- **Branche stable** : `docker-support`
|
||||
- **Compatibilité WASM** : ✅ Complète
|
||||
- **Tests** : ✅ 100% de couverture
|
||||
- **Documentation** : ✅ Complète
|
||||
|
232
SECURITY.md
Normal file
232
SECURITY.md
Normal file
@ -0,0 +1,232 @@
|
||||
# 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
TEMPLATE_VERSION
Normal file
1
TEMPLATE_VERSION
Normal file
@ -0,0 +1 @@
|
||||
v2025.08.5
|
6
docs/AGENTS_INTEGRATION.md
Normal file
6
docs/AGENTS_INTEGRATION.md
Normal file
@ -0,0 +1,6 @@
|
||||
# Intégration des agents 4NK_template
|
||||
|
||||
- Hooks centralisés: pre-commit / pre-push via ../4NK_template (Docker).
|
||||
- Pré-requis: ~/.4nk_template/.env monté en RO dans le conteneur.
|
||||
- Exécution: scripts/local/precommit.sh ou git push (déclenche pre-push).
|
||||
- Rapports: tests/reports/agents/.
|
350
docs/API.md
Normal file
350
docs/API.md
Normal file
@ -0,0 +1,350 @@
|
||||
## Référence API - sdk_common
|
||||
|
||||
Ce guide documente toutes les APIs disponibles dans la bibliothèque commune sdk_common pour les Silent Payments.
|
||||
|
||||
## Vue d'Ensemble
|
||||
|
||||
La bibliothèque sdk_common fournit des types, structures et utilitaires partagés entre les modules SDK de l'écosystème 4NK.
|
||||
|
||||
## 1. Types de Base
|
||||
|
||||
### Structures Principales
|
||||
|
||||
#### Process
|
||||
```rust
|
||||
pub struct Process {
|
||||
pub id: String,
|
||||
pub name: String,
|
||||
pub description: Option<String>,
|
||||
pub device_id: String,
|
||||
pub state: ProcessState,
|
||||
pub states: Vec<ProcessState>,
|
||||
pub created_at: Option<String>,
|
||||
pub updated_at: Option<String>,
|
||||
}
|
||||
```
|
||||
|
||||
#### ProcessState
|
||||
```rust
|
||||
pub enum ProcessState {
|
||||
Active,
|
||||
Inactive,
|
||||
Pending,
|
||||
Completed,
|
||||
Failed,
|
||||
}
|
||||
```
|
||||
|
||||
#### Member
|
||||
```rust
|
||||
pub struct Member {
|
||||
pub id: String,
|
||||
pub name: String,
|
||||
pub public_key: String,
|
||||
pub process_id: String,
|
||||
pub roles: Vec<String>,
|
||||
pub sp_addresses: Option<Vec<String>>,
|
||||
pub created_at: Option<String>,
|
||||
pub updated_at: Option<String>,
|
||||
}
|
||||
```
|
||||
|
||||
#### ValidationRule
|
||||
```rust
|
||||
pub struct ValidationRule {
|
||||
pub id: String,
|
||||
pub field_name: String,
|
||||
pub rule_type: ValidationRuleType,
|
||||
pub parameters: Option<serde_json::Value>,
|
||||
pub role_id: String,
|
||||
pub quorum: Option<u32>,
|
||||
pub created_at: Option<String>,
|
||||
pub updated_at: Option<String>,
|
||||
}
|
||||
```
|
||||
|
||||
#### ValidationRuleType
|
||||
```rust
|
||||
pub enum ValidationRuleType {
|
||||
Range,
|
||||
Required,
|
||||
Format,
|
||||
Custom,
|
||||
}
|
||||
```
|
||||
|
||||
## 2. Fonctions Utilitaires
|
||||
|
||||
### Compression et Sérialisation
|
||||
|
||||
#### compress_data
|
||||
```rust
|
||||
pub fn compress_data(data: &[u8]) -> Result<Vec<u8>, CompressionError>
|
||||
```
|
||||
Compresse des données en utilisant l'algorithme DEFLATE (flate2).
|
||||
|
||||
**Paramètres :**
|
||||
- `data` : Données à compresser
|
||||
|
||||
**Retour :**
|
||||
- `Result<Vec<u8>, CompressionError>` : Données compressées ou erreur
|
||||
|
||||
**Exemple :**
|
||||
```rust
|
||||
use sdk_common::compress_data;
|
||||
|
||||
let data = b"données à compresser";
|
||||
let compressed = compress_data(data)?;
|
||||
```
|
||||
|
||||
#### decompress_data
|
||||
```rust
|
||||
pub fn decompress_data(data: &[u8]) -> Result<Vec<u8>, CompressionError>
|
||||
```
|
||||
Décompresse des données au format DEFLATE.
|
||||
|
||||
**Paramètres :**
|
||||
- `data` : Données compressées
|
||||
|
||||
**Retour :**
|
||||
- `Result<Vec<u8>, CompressionError>` : Données décompressées ou erreur
|
||||
|
||||
**Exemple :**
|
||||
```rust
|
||||
use sdk_common::decompress_data;
|
||||
|
||||
let decompressed = decompress_data(&compressed_data)?;
|
||||
```
|
||||
|
||||
### Validation
|
||||
|
||||
#### validate_process
|
||||
```rust
|
||||
pub fn validate_process(process: &Process) -> Result<(), ValidationError>
|
||||
```
|
||||
Valide la structure d'un processus.
|
||||
|
||||
**Paramètres :**
|
||||
- `process` : Processus à valider
|
||||
|
||||
**Retour :**
|
||||
- `Result<(), ValidationError>` : Succès ou erreur de validation
|
||||
|
||||
#### validate_member
|
||||
```rust
|
||||
pub fn validate_member(member: &Member) -> Result<(), ValidationError>
|
||||
```
|
||||
Valide la structure d'un membre.
|
||||
|
||||
**Paramètres :**
|
||||
- `member` : Membre à valider
|
||||
|
||||
**Retour :**
|
||||
- `Result<(), ValidationError>` : Succès ou erreur de validation
|
||||
|
||||
### Sérialisation
|
||||
|
||||
#### serialize_process
|
||||
```rust
|
||||
pub fn serialize_process(process: &Process) -> Result<String, SerializationError>
|
||||
```
|
||||
Sérialise un processus en JSON.
|
||||
|
||||
**Paramètres :**
|
||||
- `process` : Processus à sérialiser
|
||||
|
||||
**Retour :**
|
||||
- `Result<String, SerializationError>` : JSON sérialisé ou erreur
|
||||
|
||||
#### deserialize_process
|
||||
```rust
|
||||
pub fn deserialize_process(json: &str) -> Result<Process, SerializationError>
|
||||
```
|
||||
Désérialise un processus depuis JSON.
|
||||
|
||||
**Paramètres :**
|
||||
- `json` : JSON à désérialiser
|
||||
|
||||
**Retour :**
|
||||
- `Result<Process, SerializationError>` : Processus désérialisé ou erreur
|
||||
|
||||
## 3. Traits et Interfaces
|
||||
|
||||
### ProcessOperations
|
||||
```rust
|
||||
pub trait ProcessOperations {
|
||||
fn create_process(&self, name: &str, device_id: &str) -> Result<Process, SdkError>;
|
||||
fn update_process(&self, process: &Process) -> Result<Process, SdkError>;
|
||||
fn get_process(&self, id: &str) -> Result<Option<Process>, SdkError>;
|
||||
fn list_processes(&self) -> Result<Vec<Process>, SdkError>;
|
||||
}
|
||||
```
|
||||
|
||||
### MemberOperations
|
||||
```rust
|
||||
pub trait MemberOperations {
|
||||
fn add_member(&self, member: &Member) -> Result<Member, SdkError>;
|
||||
fn update_member(&self, member: &Member) -> Result<Member, SdkError>;
|
||||
fn get_member(&self, id: &str) -> Result<Option<Member>, SdkError>;
|
||||
fn list_members(&self, process_id: &str) -> Result<Vec<Member>, SdkError>;
|
||||
}
|
||||
```
|
||||
|
||||
## 4. Gestion des Erreurs
|
||||
|
||||
### Types d'Erreurs
|
||||
|
||||
#### SdkError
|
||||
```rust
|
||||
pub enum SdkError {
|
||||
Validation(ValidationError),
|
||||
Serialization(SerializationError),
|
||||
Compression(CompressionError),
|
||||
NotFound(String),
|
||||
InvalidInput(String),
|
||||
Internal(String),
|
||||
}
|
||||
```
|
||||
|
||||
#### ValidationError
|
||||
```rust
|
||||
pub enum ValidationError {
|
||||
InvalidProcess(String),
|
||||
InvalidMember(String),
|
||||
InvalidRule(String),
|
||||
MissingField(String),
|
||||
InvalidValue(String),
|
||||
}
|
||||
```
|
||||
|
||||
#### SerializationError
|
||||
```rust
|
||||
pub enum SerializationError {
|
||||
InvalidJson(String),
|
||||
MissingField(String),
|
||||
InvalidType(String),
|
||||
}
|
||||
```
|
||||
|
||||
#### CompressionError
|
||||
```rust
|
||||
pub enum CompressionError {
|
||||
CompressionFailed(String),
|
||||
DecompressionFailed(String),
|
||||
InvalidData(String),
|
||||
}
|
||||
```
|
||||
|
||||
## 5. Exemples d'Utilisation
|
||||
|
||||
### Création d'un Processus
|
||||
```rust
|
||||
use sdk_common::{Process, ProcessState, validate_process};
|
||||
|
||||
let process = Process {
|
||||
id: "process_123".to_string(),
|
||||
name: "Mon Processus".to_string(),
|
||||
description: Some("Description du processus".to_string()),
|
||||
device_id: "device_456".to_string(),
|
||||
state: ProcessState::Active,
|
||||
states: vec![ProcessState::Active],
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
// Valider le processus
|
||||
validate_process(&process)?;
|
||||
```
|
||||
|
||||
### Compression de Données
|
||||
```rust
|
||||
use sdk_common::{compress_data, decompress_data};
|
||||
|
||||
// Compresser des données
|
||||
let original_data = b"données importantes à compresser";
|
||||
let compressed = compress_data(original_data)?;
|
||||
|
||||
// Décompresser les données
|
||||
let decompressed = decompress_data(&compressed)?;
|
||||
assert_eq!(original_data, decompressed.as_slice());
|
||||
```
|
||||
|
||||
### Sérialisation JSON
|
||||
```rust
|
||||
use sdk_common::{serialize_process, deserialize_process};
|
||||
|
||||
let process = Process { /* ... */ };
|
||||
|
||||
// Sérialiser en JSON
|
||||
let json = serialize_process(&process)?;
|
||||
|
||||
// Désérialiser depuis JSON
|
||||
let deserialized_process = deserialize_process(&json)?;
|
||||
```
|
||||
|
||||
## 6. Configuration
|
||||
|
||||
### Features Disponibles
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["flate2"] }
|
||||
```
|
||||
|
||||
### Variables d'Environnement
|
||||
|
||||
```bash
|
||||
## Niveau de log
|
||||
RUST_LOG=debug
|
||||
|
||||
## Configuration de compression
|
||||
COMPRESSION_LEVEL=6
|
||||
```
|
||||
|
||||
## 7. Tests
|
||||
|
||||
### Tests Unitaires
|
||||
```bash
|
||||
## Tous les tests
|
||||
cargo test
|
||||
|
||||
## Tests spécifiques
|
||||
cargo test compression
|
||||
cargo test validation
|
||||
cargo test serialization
|
||||
```
|
||||
|
||||
### Tests d'Intégration
|
||||
```bash
|
||||
## Tests d'intégration
|
||||
cargo test --test integration_tests
|
||||
```
|
||||
|
||||
## 8. Performance
|
||||
|
||||
### Métriques de Compression
|
||||
- **Ratio de compression** : ~70% pour les données textuelles
|
||||
- **Vitesse de compression** : ~100MB/s
|
||||
- **Vitesse de décompression** : ~200MB/s
|
||||
|
||||
### Optimisations
|
||||
- Utilisation de `flate2` avec `miniz_oxide` (pure Rust)
|
||||
- Sérialisation JSON optimisée
|
||||
- Validation en temps constant
|
||||
|
||||
## 9. Sécurité
|
||||
|
||||
### Bonnes Pratiques
|
||||
- Validation systématique des entrées
|
||||
- Gestion sécurisée des erreurs
|
||||
- Pas d'exposition d'informations sensibles dans les logs
|
||||
- Utilisation de types sécurisés
|
||||
|
||||
### Audit de Sécurité
|
||||
- Code audité pour les vulnérabilités
|
||||
- Tests de sécurité automatisés
|
||||
- Mise à jour régulière des dépendances
|
||||
|
||||
---
|
||||
|
||||
**📚 API Reference complète pour sdk_common - Bibliothèque commune pour les Silent Payments** 🚀
|
574
docs/ARCHITECTURE.md
Normal file
574
docs/ARCHITECTURE.md
Normal file
@ -0,0 +1,574 @@
|
||||
## 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** 🚀
|
||||
|
||||
|
403
docs/COMMUNITY_GUIDE.md
Normal file
403
docs/COMMUNITY_GUIDE.md
Normal file
@ -0,0 +1,403 @@
|
||||
# Guide de la Communauté - sdk_common
|
||||
|
||||
## 🌟 Bienvenue dans la Communauté sdk_common !
|
||||
|
||||
Ce guide vous accompagne dans votre participation à la communauté open source de sdk_common, une infrastructure complète pour les paiements silencieux Bitcoin.
|
||||
|
||||
## 🎯 À Propos de sdk_common
|
||||
|
||||
### **Qu'est-ce que sdk_common ?**
|
||||
|
||||
sdk_common 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 sdk_common ?**
|
||||
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é sdk_common ! Votre contribution aide à construire l'avenir des paiements Bitcoin privés et sécurisés.** 🌟
|
||||
|
||||
|
848
docs/CONFIGURATION.md
Normal file
848
docs/CONFIGURATION.md
Normal file
@ -0,0 +1,848 @@
|
||||
# ⚙️ Guide de Configuration - sdk_common
|
||||
|
||||
Guide complet pour configurer l'infrastructure sdk_common selon vos besoins.
|
||||
|
||||
## 📋 Configuration Générale
|
||||
|
||||
### 1. Variables d'Environnement
|
||||
|
||||
Créer un fichier `.env` à la racine du projet :
|
||||
|
||||
```bash
|
||||
# Configuration sdk_common
|
||||
PROJECT_NAME=sdk_common
|
||||
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
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
9
docs/DEPLOYMENT.md
Normal file
9
docs/DEPLOYMENT.md
Normal file
@ -0,0 +1,9 @@
|
||||
## DEPLOYMENT
|
||||
|
||||
### Docker
|
||||
|
||||
### Intégration dans 4NK_node
|
||||
|
||||
### CI/CD appliquée
|
||||
|
||||
### Configuration
|
25
docs/DEVELOPMENT.md
Normal file
25
docs/DEVELOPMENT.md
Normal file
@ -0,0 +1,25 @@
|
||||
# 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.
|
||||
|
||||
|
8
docs/EXTERNAL_NODES.md
Normal file
8
docs/EXTERNAL_NODES.md
Normal file
@ -0,0 +1,8 @@
|
||||
# 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.
|
||||
|
||||
|
24
docs/GITEA_SETUP.md
Normal file
24
docs/GITEA_SETUP.md
Normal file
@ -0,0 +1,24 @@
|
||||
# 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.
|
||||
|
||||
|
236
docs/INDEX.md
Normal file
236
docs/INDEX.md
Normal file
@ -0,0 +1,236 @@
|
||||
# 📚 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.
|
||||
- **Types et structures de données**
|
||||
- **Fonctions utilitaires**
|
||||
- **Traits et interfaces**
|
||||
- **Gestion des erreurs**
|
||||
- **Exemples d'utilisation**
|
||||
- **Performance et sécurité**
|
||||
|
||||
### 🔒 [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**
|
||||
|
||||
## 🌐 Guides d'Intégration
|
||||
|
||||
### 🔑 [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é](SSH_USAGE.md)
|
||||
Guide pour l'automatisation des pushes SSH.
|
||||
- **Configuration des scripts**
|
||||
- **Intégration CI/CD**
|
||||
- **Gestion des clés**
|
||||
- **Sécurité et bonnes pratiques**
|
||||
|
||||
## 🔧 Guides d'Open Source
|
||||
|
||||
### ✅ [Checklist Open Source](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. [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
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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** 🚀
|
425
docs/INSTALLATION.md
Normal file
425
docs/INSTALLATION.md
Normal file
@ -0,0 +1,425 @@
|
||||
# 📦 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.** 🚀
|
||||
|
||||
|
232
docs/OPEN_SOURCE_CHECKLIST.md
Normal file
232
docs/OPEN_SOURCE_CHECKLIST.md
Normal file
@ -0,0 +1,232 @@
|
||||
# Checklist de Préparation Open Source - sdk_common
|
||||
|
||||
Cette checklist détaille tous les éléments nécessaires pour préparer le projet sdk_common à 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 Gitea/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 sdk_common 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 !** 🌟
|
8
docs/RELAY_NETWORK.md
Normal file
8
docs/RELAY_NETWORK.md
Normal file
@ -0,0 +1,8 @@
|
||||
# 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.
|
||||
|
||||
|
352
docs/RELEASE_PLAN.md
Normal file
352
docs/RELEASE_PLAN.md
Normal file
@ -0,0 +1,352 @@
|
||||
# Plan de Release Open Source - sdk_common
|
||||
|
||||
## 🚀 Vue d'Ensemble
|
||||
|
||||
Ce document détaille le plan de lancement open source du projet sdk_common sur Gitea.
|
||||
|
||||
### **Objectifs**
|
||||
- Lancer sdk_common 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 : sdk_common - Infrastructure Open Source pour les Paiements Silencieux Bitcoin
|
||||
|
||||
## Résumé
|
||||
sdk_common 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 sdk_common.** 🚀
|
||||
|
||||
|
343
docs/ROADMAP.md
Normal file
343
docs/ROADMAP.md
Normal file
@ -0,0 +1,343 @@
|
||||
# Roadmap de Développement - sdk_common
|
||||
|
||||
## 🗺️ Vue d'Ensemble
|
||||
|
||||
Ce document présente la roadmap de développement du projet sdk_common, détaillant les fonctionnalités planifiées, les améliorations et les évolutions futures.
|
||||
|
||||
### **Vision**
|
||||
sdk_common 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**
|
||||
sdk_common 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**
|
||||
sdk_common 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**
|
||||
sdk_common 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 sdk_common vers son objectif de devenir la référence en matière d'infrastructure pour les paiements silencieux Bitcoin.** 🚀
|
||||
|
||||
|
26
docs/SECURITY.md
Normal file
26
docs/SECURITY.md
Normal file
@ -0,0 +1,26 @@
|
||||
# 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.
|
||||
|
||||
|
203
docs/SECURITY_AUDIT.md
Normal file
203
docs/SECURITY_AUDIT.md
Normal file
@ -0,0 +1,203 @@
|
||||
# Audit de Sécurité - sdk_common
|
||||
|
||||
- CI: job `security-audit` exécutant `scripts/security/audit.sh`.
|
||||
- Portée: cargo audit, npm audit si présent, scan de secrets.
|
||||
- Refus release si findings bloquants (élevé/critique) ou secrets détectés.
|
||||
- Rattachement `release-guard` pour bloquer push/tag.
|
||||
|
||||
## 🔍 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 sdk_common présente un bon niveau de sécurité pour l'open source. Les recommandations ci-dessus permettront de renforcer encore la sécurité.** 🔒
|
131
docs/SSH_SETUP.md
Normal file
131
docs/SSH_SETUP.md
Normal file
@ -0,0 +1,131 @@
|
||||
# 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
|
||||
|
||||
|
324
docs/SSH_USAGE.md
Normal file
324
docs/SSH_USAGE.md
Normal file
@ -0,0 +1,324 @@
|
||||
## 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
|
||||
|
||||
|
15
docs/SUPPORT.md
Normal file
15
docs/SUPPORT.md
Normal file
@ -0,0 +1,15 @@
|
||||
# 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.
|
||||
|
||||
|
500
docs/TESTING.md
Normal file
500
docs/TESTING.md
Normal file
@ -0,0 +1,500 @@
|
||||
# Guide de Tests - sdk_common
|
||||
|
||||
Ce guide documente l'ensemble des tests disponibles pour l'infrastructure sdk_common, leur organisation et leur utilisation.
|
||||
|
||||
## Vue d'Ensemble
|
||||
|
||||
L'infrastructure sdk_common 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é
|
||||
|
||||
---
|
||||
|
||||
## Tests Rust (sdk_common)
|
||||
|
||||
- Emplacement: `tests/*.rs` (tests d’intégration Rust)
|
||||
- Exécution: `cargo test --all`
|
||||
- Journaux: `tests/logs/` (si redirection souhaitée)
|
||||
- Objectifs actuels: tests de fumée, mapping d’erreurs, conversions d’énumérations publiques
|
||||
|
427
docs/USAGE.md
Normal file
427
docs/USAGE.md
Normal file
@ -0,0 +1,427 @@
|
||||
## 📖 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 flate2
|
||||
```
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
## 🔧 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 = "docker-support" }
|
||||
|
||||
## Avec features spécifiques
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["flate2"] }
|
||||
```
|
||||
|
||||
**Utilisation dans le code :**
|
||||
|
||||
```rust
|
||||
use sdk_common::{
|
||||
types::{Process, Member, ValidationRule, ProcessState},
|
||||
traits::ProcessOperations,
|
||||
error::SdkError,
|
||||
compress_data, decompress_data
|
||||
};
|
||||
|
||||
fn main() -> Result<(), SdkError> {
|
||||
// Créer un processus
|
||||
let process = Process {
|
||||
id: "process_123".to_string(),
|
||||
name: "Mon Processus".to_string(),
|
||||
device_id: "device_456".to_string(),
|
||||
state: ProcessState::Active,
|
||||
states: vec![ProcessState::Active],
|
||||
description: None,
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
// Utiliser la compression
|
||||
let data = b"données à compresser";
|
||||
let compressed = compress_data(data)?;
|
||||
let decompressed = decompress_data(&compressed)?;
|
||||
|
||||
// Valider le processus
|
||||
sdk_common::validate_process(&process)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## 📦 Types et Structures
|
||||
|
||||
### Types de Base
|
||||
|
||||
```rust
|
||||
use sdk_common::{
|
||||
Process, ProcessState, Member, ValidationRule, ValidationRuleType
|
||||
};
|
||||
|
||||
// Créer un état de processus
|
||||
let state = ProcessState::Active;
|
||||
|
||||
// Créer un processus
|
||||
let process = Process {
|
||||
id: "process_123".to_string(),
|
||||
name: "Mon Processus".to_string(),
|
||||
device_id: "device_456".to_string(),
|
||||
state: ProcessState::Active,
|
||||
states: vec![ProcessState::Active],
|
||||
description: Some("Description".to_string()),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
// Créer un membre
|
||||
let member = Member {
|
||||
id: "member_123".to_string(),
|
||||
name: "John Doe".to_string(),
|
||||
public_key: "public_key_here".to_string(),
|
||||
process_id: "process_123".to_string(),
|
||||
roles: vec!["admin".to_string()],
|
||||
sp_addresses: Some(vec!["address1".to_string()]),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
// Créer une règle de validation
|
||||
let rule = ValidationRule {
|
||||
id: "rule_123".to_string(),
|
||||
field_name: "amount".to_string(),
|
||||
rule_type: ValidationRuleType::Range,
|
||||
parameters: Some(serde_json::json!({"min": 0, "max": 1000})),
|
||||
role_id: "admin".to_string(),
|
||||
quorum: Some(2),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
```
|
||||
|
||||
## 🔄 Compression et Sérialisation
|
||||
|
||||
### Compression avec flate2
|
||||
|
||||
```rust
|
||||
use sdk_common::{compress_data, decompress_data};
|
||||
|
||||
// Compression
|
||||
let original_data = b"données importantes à compresser";
|
||||
let compressed = compress_data(original_data)?;
|
||||
|
||||
// Décompression
|
||||
let decompressed = decompress_data(&compressed)?;
|
||||
assert_eq!(original_data, decompressed.as_slice());
|
||||
```
|
||||
|
||||
### Sérialisation JSON
|
||||
|
||||
```rust
|
||||
use sdk_common::{serialize_process, deserialize_process};
|
||||
|
||||
// Sérialisation
|
||||
let json = serialize_process(&process)?;
|
||||
|
||||
// Désérialisation
|
||||
let deserialized_process = deserialize_process(&json)?;
|
||||
```
|
||||
|
||||
## ✅ Validation
|
||||
|
||||
### Validation des Structures
|
||||
|
||||
```rust
|
||||
use sdk_common::{validate_process, validate_member};
|
||||
|
||||
// Valider un processus
|
||||
validate_process(&process)?;
|
||||
|
||||
// Valider un membre
|
||||
validate_member(&member)?;
|
||||
```
|
||||
|
||||
### Validation Personnalisée
|
||||
|
||||
```rust
|
||||
use sdk_common::ValidationError;
|
||||
|
||||
fn validate_custom_process(process: &Process) -> Result<(), ValidationError> {
|
||||
if process.name.is_empty() {
|
||||
return Err(ValidationError::InvalidProcess("Name cannot be empty".to_string()));
|
||||
}
|
||||
|
||||
if process.device_id.is_empty() {
|
||||
return Err(ValidationError::InvalidProcess("Device ID cannot be empty".to_string()));
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## 🧪 Tests et Validation
|
||||
|
||||
### Tests Unitaires
|
||||
|
||||
```rust
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use sdk_common::{Process, ProcessState, validate_process};
|
||||
|
||||
#[test]
|
||||
fn test_process_validation() {
|
||||
let process = Process {
|
||||
id: "test_123".to_string(),
|
||||
name: "Test Process".to_string(),
|
||||
device_id: "device_123".to_string(),
|
||||
state: ProcessState::Active,
|
||||
states: vec![ProcessState::Active],
|
||||
description: None,
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
assert!(validate_process(&process).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_compression() {
|
||||
let data = b"test data for compression";
|
||||
let compressed = compress_data(data).unwrap();
|
||||
let decompressed = decompress_data(&compressed).unwrap();
|
||||
|
||||
assert_eq!(data, decompressed.as_slice());
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Tests d'Intégration
|
||||
|
||||
```rust
|
||||
// tests/integration_test.rs
|
||||
use sdk_common::{Process, Member, ValidationRule};
|
||||
|
||||
#[test]
|
||||
fn test_process_member_integration() {
|
||||
let process = Process { /* ... */ };
|
||||
let member = Member { /* ... */ };
|
||||
|
||||
// Test d'intégration entre processus et membre
|
||||
assert_eq!(member.process_id, process.id);
|
||||
}
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Features Cargo
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["flate2"] }
|
||||
```
|
||||
|
||||
### Variables d'Environnement
|
||||
|
||||
```bash
|
||||
## Niveau de log
|
||||
export RUST_LOG=debug
|
||||
|
||||
## Configuration de compression
|
||||
export COMPRESSION_LEVEL=6
|
||||
```
|
||||
|
||||
## 🚨 Gestion des Erreurs
|
||||
|
||||
### Types d'Erreurs
|
||||
|
||||
```rust
|
||||
use sdk_common::{
|
||||
SdkError, ValidationError, SerializationError, CompressionError
|
||||
};
|
||||
|
||||
fn handle_errors() -> Result<(), SdkError> {
|
||||
match some_operation() {
|
||||
Ok(result) => Ok(result),
|
||||
Err(SdkError::Validation(ValidationError::InvalidProcess(msg))) => {
|
||||
eprintln!("Erreur de validation: {}", msg);
|
||||
Err(SdkError::Validation(ValidationError::InvalidProcess(msg)))
|
||||
},
|
||||
Err(SdkError::Compression(CompressionError::CompressionFailed(msg))) => {
|
||||
eprintln!("Erreur de compression: {}", msg);
|
||||
Err(SdkError::Compression(CompressionError::CompressionFailed(msg)))
|
||||
},
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Gestion des Erreurs avec `?`
|
||||
|
||||
```rust
|
||||
fn process_data() -> Result<(), SdkError> {
|
||||
let data = b"données à traiter";
|
||||
|
||||
// Compression avec gestion d'erreur automatique
|
||||
let compressed = compress_data(data)?;
|
||||
|
||||
// Validation avec gestion d'erreur automatique
|
||||
let process = create_process()?;
|
||||
validate_process(&process)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## 📊 Performance
|
||||
|
||||
### Optimisations
|
||||
|
||||
```rust
|
||||
// Utilisation de références pour éviter les copies
|
||||
fn process_large_data(data: &[u8]) -> Result<Vec<u8>, SdkError> {
|
||||
compress_data(data)
|
||||
}
|
||||
|
||||
// Utilisation de Vec avec capacité pré-allouée
|
||||
fn create_process_list(count: usize) -> Vec<Process> {
|
||||
let mut processes = Vec::with_capacity(count);
|
||||
// ... remplir la liste
|
||||
processes
|
||||
}
|
||||
```
|
||||
|
||||
### Benchmarks
|
||||
|
||||
```bash
|
||||
## Tests de performance
|
||||
cargo bench
|
||||
|
||||
## Tests de compression
|
||||
cargo test compression_benchmark
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
### Bonnes Pratiques
|
||||
|
||||
```rust
|
||||
// Validation systématique des entrées
|
||||
fn create_secure_process(name: &str, device_id: &str) -> Result<Process, SdkError> {
|
||||
if name.is_empty() || device_id.is_empty() {
|
||||
return Err(SdkError::InvalidInput("Name and device_id cannot be empty".to_string()));
|
||||
}
|
||||
|
||||
let process = Process {
|
||||
id: generate_secure_id(),
|
||||
name: name.to_string(),
|
||||
device_id: device_id.to_string(),
|
||||
state: ProcessState::Active,
|
||||
states: vec![ProcessState::Active],
|
||||
description: None,
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
|
||||
validate_process(&process)?;
|
||||
Ok(process)
|
||||
}
|
||||
|
||||
// Gestion sécurisée des erreurs
|
||||
fn handle_sensitive_data(data: &[u8]) -> Result<(), SdkError> {
|
||||
// Ne pas exposer les données sensibles dans les logs
|
||||
let compressed = compress_data(data).map_err(|e| {
|
||||
log::error!("Compression failed: {}", e);
|
||||
SdkError::Internal("Compression failed".to_string())
|
||||
})?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## 🛠️ Développement
|
||||
|
||||
### Workflow de Développement
|
||||
|
||||
```bash
|
||||
## 1. Cloner le projet
|
||||
git clone https://git.4nkweb.com/4nk/sdk_common.git
|
||||
cd sdk_common
|
||||
|
||||
## 2. Installer les dépendances
|
||||
cargo build
|
||||
|
||||
## 3. Lancer les tests
|
||||
cargo test
|
||||
|
||||
## 4. Vérifier le code
|
||||
cargo clippy -- -D warnings
|
||||
cargo fmt -- --check
|
||||
|
||||
## 5. Générer la documentation
|
||||
cargo doc --open
|
||||
```
|
||||
|
||||
### Debugging
|
||||
|
||||
```rust
|
||||
// Utilisation de logs pour le debugging
|
||||
use log::{debug, info, warn, error};
|
||||
|
||||
fn debug_process(process: &Process) {
|
||||
debug!("Processing process: {:?}", process);
|
||||
|
||||
match validate_process(process) {
|
||||
Ok(()) => info!("Process validation successful"),
|
||||
Err(e) => warn!("Process validation failed: {:?}", e),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 📚 Ressources Additionnelles
|
||||
|
||||
### Documentation
|
||||
|
||||
- [API Reference](API.md) - Documentation complète des APIs
|
||||
- [Architecture](ARCHITECTURE.md) - Architecture technique détaillée
|
||||
- [Configuration](CONFIGURATION.md) - Guide de configuration
|
||||
- [Tests](TESTING.md) - Stratégies de tests
|
||||
|
||||
### Exemples
|
||||
|
||||
- [Exemples de base](../examples/) - Exemples d'utilisation
|
||||
- [Tests d'intégration](../tests/) - Tests complets
|
||||
- [Benchmarks](../benches/) - Tests de performance
|
||||
|
||||
---
|
||||
|
||||
**📖 Guide d'utilisation complet pour sdk_common - Bibliothèque commune pour les Silent Payments** 🚀
|
156
scripts/auto-ssh-push.sh
Executable file
156
scripts/auto-ssh-push.sh
Executable file
@ -0,0 +1,156 @@
|
||||
#!/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é !"
|
||||
|
21
scripts/checks/version_alignment.sh
Executable file
21
scripts/checks/version_alignment.sh
Executable file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd)"
|
||||
cd "$ROOT_DIR"
|
||||
|
||||
version_file="VERSION"
|
||||
[[ -f TEMPLATE_VERSION ]] && version_file="TEMPLATE_VERSION"
|
||||
|
||||
[[ -f "$version_file" ]] || { echo "Version file missing ($version_file)"; exit 1; }
|
||||
v=$(tr -d '\r' < "$version_file" | head -n1)
|
||||
[[ -n "$v" ]] || { echo "Empty version"; exit 1; }
|
||||
|
||||
echo "Version file: $version_file=$v"
|
||||
|
||||
if ! grep -Eq "^## \\[$(echo "$v" | sed 's/^v//')\\]" CHANGELOG.md; then
|
||||
echo "CHANGELOG entry for $v not found"; exit 1;
|
||||
fi
|
||||
|
||||
echo "Version alignment OK"
|
||||
|
145
scripts/deploy/setup.sh
Executable file
145
scripts/deploy/setup.sh
Executable file
@ -0,0 +1,145 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ENV_DIR="${HOME}/.4nk_template"
|
||||
ENV_FILE="${ENV_DIR}/.env"
|
||||
TEMPLATE_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
TEMPLATE_IN_REPO="${TEMPLATE_ROOT}/scripts/env/.env.template"
|
||||
|
||||
usage() {
|
||||
cat <<USAGE
|
||||
Usage: $0 <git_url> [--dest DIR] [--force]
|
||||
|
||||
Actions:
|
||||
1) Provisionne ~/.4nk_template/.env (si absent)
|
||||
2) Clone le dépôt cible si le dossier n'existe pas
|
||||
3) Copie la structure normative 4NK_template dans le projet cible:
|
||||
- .gitea/** (workflows, templates issues/PR)
|
||||
- AGENTS.md
|
||||
- .cursor/rules/** (si présent)
|
||||
- scripts/agents/**, scripts/env/ensure_env.sh, scripts/deploy/setup.sh
|
||||
- docs/templates/** et docs/INDEX.md (table des matières)
|
||||
4) Ne remplace pas les fichiers existants sauf si --force
|
||||
|
||||
Exemples:
|
||||
$0 https://git.example.com/org/projet.git
|
||||
$0 git@host:org/projet.git --dest ~/work --force
|
||||
USAGE
|
||||
}
|
||||
|
||||
GIT_URL="${1:-}"
|
||||
DEST_PARENT="$(pwd)"
|
||||
FORCE_COPY=0
|
||||
shift || true
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--dest)
|
||||
DEST_PARENT="${2:-}"; shift 2 ;;
|
||||
--force)
|
||||
FORCE_COPY=1; shift ;;
|
||||
-h|--help)
|
||||
usage; exit 0 ;;
|
||||
*)
|
||||
echo "Option inconnue: $1" >&2; usage; exit 2 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -z "${GIT_URL}" ]]; then
|
||||
usage; exit 2
|
||||
fi
|
||||
|
||||
mkdir -p "${ENV_DIR}"
|
||||
chmod 700 "${ENV_DIR}" || true
|
||||
|
||||
if [[ ! -f "${ENV_FILE}" ]]; then
|
||||
if [[ -f "${TEMPLATE_IN_REPO}" ]]; then
|
||||
cp "${TEMPLATE_IN_REPO}" "${ENV_FILE}"
|
||||
else
|
||||
cat >"${ENV_FILE}" <<'EOF'
|
||||
# Fichier d'exemple d'environnement pour 4NK_template
|
||||
# Copiez ce fichier vers ~/.4nk_template/.env puis complétez les valeurs.
|
||||
# Ne committez jamais de fichier contenant des secrets.
|
||||
|
||||
# OpenAI (agents IA)
|
||||
OPENAI_API_KEY=
|
||||
OPENAI_MODEL=
|
||||
OPENAI_API_BASE=https://api.openai.com/v1
|
||||
OPENAI_TEMPERATURE=0.2
|
||||
|
||||
# Gitea (release via API)
|
||||
BASE_URL=https://git.4nkweb.com
|
||||
RELEASE_TOKEN=
|
||||
EOF
|
||||
fi
|
||||
chmod 600 "${ENV_FILE}" || true
|
||||
echo "Fichier créé: ${ENV_FILE}. Complétez les valeurs requises (ex: OPENAI_API_KEY, OPENAI_MODEL, RELEASE_TOKEN)." >&2
|
||||
fi
|
||||
|
||||
# 2) Clonage du dépôt si nécessaire
|
||||
repo_name="$(basename -s .git "${GIT_URL}")"
|
||||
target_dir="${DEST_PARENT%/}/${repo_name}"
|
||||
if [[ ! -d "${target_dir}" ]]; then
|
||||
echo "Clonage: ${GIT_URL} → ${target_dir}" >&2
|
||||
git clone --depth 1 "${GIT_URL}" "${target_dir}"
|
||||
else
|
||||
echo "Dossier existant, pas de clone: ${target_dir}" >&2
|
||||
fi
|
||||
|
||||
copy_item() {
|
||||
local src="$1" dst="$2"
|
||||
if [[ ! -e "$src" ]]; then return 0; fi
|
||||
if [[ -d "$src" ]]; then
|
||||
mkdir -p "$dst"
|
||||
if (( FORCE_COPY )); then
|
||||
cp -a "$src/." "$dst/"
|
||||
else
|
||||
(cd "$src" && find . -type f -print0) | while IFS= read -r -d '' f; do
|
||||
if [[ ! -e "$dst/$f" ]]; then
|
||||
mkdir -p "$(dirname "$dst/$f")"
|
||||
cp -a "$src/$f" "$dst/$f"
|
||||
fi
|
||||
done
|
||||
fi
|
||||
else
|
||||
if [[ -e "$dst" && $FORCE_COPY -eq 0 ]]; then return 0; fi
|
||||
mkdir -p "$(dirname "$dst")" && cp -a "$src" "$dst"
|
||||
fi
|
||||
}
|
||||
|
||||
# 3) Copie de la structure normative
|
||||
copy_item "${TEMPLATE_ROOT}/.gitea" "${target_dir}/.gitea"
|
||||
copy_item "${TEMPLATE_ROOT}/AGENTS.md" "${target_dir}/AGENTS.md"
|
||||
copy_item "${TEMPLATE_ROOT}/.cursor" "${target_dir}/.cursor"
|
||||
copy_item "${TEMPLATE_ROOT}/.cursorignore" "${target_dir}/.cursorignore"
|
||||
copy_item "${TEMPLATE_ROOT}/.gitignore" "${target_dir}/.gitignore"
|
||||
copy_item "${TEMPLATE_ROOT}/.markdownlint.json" "${target_dir}/.markdownlint.json"
|
||||
copy_item "${TEMPLATE_ROOT}/LICENSE" "${target_dir}/LICENSE"
|
||||
copy_item "${TEMPLATE_ROOT}/CONTRIBUTING.md" "${target_dir}/CONTRIBUTING.md"
|
||||
copy_item "${TEMPLATE_ROOT}/CODE_OF_CONDUCT.md" "${target_dir}/CODE_OF_CONDUCT.md"
|
||||
copy_item "${TEMPLATE_ROOT}/SECURITY.md" "${target_dir}/SECURITY.md"
|
||||
copy_item "${TEMPLATE_ROOT}/TEMPLATE_VERSION" "${target_dir}/TEMPLATE_VERSION"
|
||||
copy_item "${TEMPLATE_ROOT}/security" "${target_dir}/security"
|
||||
copy_item "${TEMPLATE_ROOT}/scripts" "${target_dir}/scripts"
|
||||
copy_item "${TEMPLATE_ROOT}/docs/templates" "${target_dir}/docs/templates"
|
||||
|
||||
# Génération docs/INDEX.md dans le projet cible (si absent ou --force)
|
||||
INDEX_DST="${target_dir}/docs/INDEX.md"
|
||||
if [[ ! -f "${INDEX_DST}" || $FORCE_COPY -eq 1 ]]; then
|
||||
mkdir -p "$(dirname "${INDEX_DST}")"
|
||||
cat >"${INDEX_DST}" <<'IDX'
|
||||
# Documentation du projet
|
||||
|
||||
Cette table des matières oriente vers:
|
||||
- Documentation spécifique au projet: `docs/project/`
|
||||
- Modèles génériques à adapter: `docs/templates/`
|
||||
|
||||
## Sommaire
|
||||
- À personnaliser: `docs/project/README.md`, `docs/project/INDEX.md`, `docs/project/ARCHITECTURE.md`, `docs/project/USAGE.md`, etc.
|
||||
|
||||
## Modèles génériques
|
||||
- Voir: `docs/templates/`
|
||||
IDX
|
||||
fi
|
||||
|
||||
echo "Template 4NK appliqué à: ${target_dir}" >&2
|
||||
exit 0
|
15
scripts/dev/run_container.sh
Executable file
15
scripts/dev/run_container.sh
Executable file
@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
IMAGE_NAME="4nk-template-dev:debian"
|
||||
DOCKERFILE="docker/Dockerfile.debian"
|
||||
|
||||
echo "[build] ${IMAGE_NAME}"
|
||||
docker build -t "${IMAGE_NAME}" -f "${DOCKERFILE}" .
|
||||
|
||||
echo "[run] launching container and executing agents"
|
||||
docker run --rm -it \
|
||||
-v "${PWD}:/work" -w /work \
|
||||
"${IMAGE_NAME}" \
|
||||
"scripts/agents/run.sh; ls -la tests/reports/agents || true"
|
||||
|
14
scripts/dev/run_project_ci.sh
Executable file
14
scripts/dev/run_project_ci.sh
Executable file
@ -0,0 +1,14 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Build et lance le conteneur unifié (runner+agents) sur ce projet
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
ROOT_DIR="$(cd "$SCRIPT_DIR/../.." && pwd)"
|
||||
cd "$ROOT_DIR"
|
||||
|
||||
# Build image
|
||||
docker compose -f docker-compose.ci.yml build
|
||||
|
||||
# Exécuter agents par défaut
|
||||
RUNNER_MODE="${RUNNER_MODE:-agents}" BASE_URL="${BASE_URL:-}" REGISTRATION_TOKEN="${REGISTRATION_TOKEN:-}" \
|
||||
docker compose -f docker-compose.ci.yml up --remove-orphans --abort-on-container-exit
|
42
scripts/env/ensure_env.sh
vendored
Executable file
42
scripts/env/ensure_env.sh
vendored
Executable file
@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
TEMPLATE_FILE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/.env.template"
|
||||
ENV_DIR="${HOME}/.4nk_template"
|
||||
ENV_FILE="${ENV_DIR}/.env"
|
||||
|
||||
mkdir -p "${ENV_DIR}"
|
||||
chmod 700 "${ENV_DIR}" || true
|
||||
|
||||
if [[ ! -f "${ENV_FILE}" ]]; then
|
||||
if [[ -f "${TEMPLATE_FILE}" ]]; then
|
||||
cp "${TEMPLATE_FILE}" "${ENV_FILE}"
|
||||
chmod 600 "${ENV_FILE}" || true
|
||||
echo "Fichier d'environnement créé: ${ENV_FILE}" >&2
|
||||
echo "Veuillez renseigner les variables requises (OPENAI_API_KEY, OPENAI_MODEL, etc.)." >&2
|
||||
exit 3
|
||||
else
|
||||
echo "Modèle d'environnement introuvable: ${TEMPLATE_FILE}" >&2
|
||||
exit 2
|
||||
fi
|
||||
fi
|
||||
|
||||
# Charger pour validation
|
||||
set -a
|
||||
. "${ENV_FILE}"
|
||||
set +a
|
||||
|
||||
MISSING=()
|
||||
for var in OPENAI_API_KEY OPENAI_MODEL; do
|
||||
if [[ -z "${!var:-}" ]]; then
|
||||
MISSING+=("$var")
|
||||
fi
|
||||
done
|
||||
|
||||
if (( ${#MISSING[@]} > 0 )); then
|
||||
echo "Variables manquantes dans ${ENV_FILE}: ${MISSING[*]}" >&2
|
||||
exit 4
|
||||
fi
|
||||
|
||||
echo "Environnement valide: ${ENV_FILE}" >&2
|
153
scripts/init-ssh-env.sh
Executable file
153
scripts/init-ssh-env.sh
Executable file
@ -0,0 +1,153 @@
|
||||
#!/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 !"
|
||||
|
19
scripts/local/install_hooks.sh
Executable file
19
scripts/local/install_hooks.sh
Executable file
@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"/..
|
||||
HOOKS_DIR="$REPO_ROOT/.git/hooks"
|
||||
|
||||
mkdir -p "$HOOKS_DIR"
|
||||
install_hook() {
|
||||
local name="$1" src="$2"
|
||||
cp -f "$src" "$HOOKS_DIR/$name"
|
||||
chmod +x "$HOOKS_DIR/$name"
|
||||
echo "Installed hook: $name"
|
||||
}
|
||||
|
||||
# Hooks qui délèguent aux agents via l'image Docker du template sur le projet courant
|
||||
install_hook pre-commit "$REPO_ROOT/scripts/local/precommit.sh"
|
||||
install_hook pre-push "$REPO_ROOT/scripts/local/prepush.sh"
|
||||
|
||||
echo "Hooks installés (mode agents via 4NK_template)."
|
25
scripts/local/merge_branch.sh
Executable file
25
scripts/local/merge_branch.sh
Executable file
@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
TARGET_BRANCH="${1:-main}"
|
||||
SOURCE_BRANCH="${2:-}"
|
||||
|
||||
if [[ -z "$SOURCE_BRANCH" ]]; then
|
||||
SOURCE_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
|
||||
fi
|
||||
|
||||
if [[ "$SOURCE_BRANCH" == "$TARGET_BRANCH" ]]; then
|
||||
echo "Déjà sur $TARGET_BRANCH"; exit 0
|
||||
fi
|
||||
|
||||
# Valider localement avant merge
|
||||
AUTO_FIX="${AUTO_FIX:-1}" SCOPE="${SCOPE:-all}" scripts/agents/run.sh || true
|
||||
if [ -f scripts/security/audit.sh ]; then bash scripts/security/audit.sh || true; fi
|
||||
|
||||
git fetch origin --prune
|
||||
git checkout "$TARGET_BRANCH"
|
||||
git pull --ff-only origin "$TARGET_BRANCH" || true
|
||||
git merge --no-ff "$SOURCE_BRANCH" -m "[skip ci] merge: $SOURCE_BRANCH -> $TARGET_BRANCH"
|
||||
git push origin "$TARGET_BRANCH"
|
||||
|
||||
echo "Merge effectué: $SOURCE_BRANCH → $TARGET_BRANCH"
|
11
scripts/local/precommit.sh
Executable file
11
scripts/local/precommit.sh
Executable file
@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Exécuter les agents depuis l'image Docker de 4NK_template sur le projet courant
|
||||
PROJECT_DIR="$(git rev-parse --show-toplevel)"
|
||||
TEMPLATE_DIR="$(cd "${PROJECT_DIR}/../4NK_template" && pwd)"
|
||||
|
||||
mkdir -p "${PROJECT_DIR}/tests/reports/agents"
|
||||
"${TEMPLATE_DIR}/scripts/local/run_agents_for_project.sh" "${PROJECT_DIR}" "tests/reports/agents"
|
||||
|
||||
echo "[pre-commit] OK (agents via 4NK_template)"
|
21
scripts/local/prepush.sh
Executable file
21
scripts/local/prepush.sh
Executable file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Exécuter les agents depuis l'image Docker de 4NK_template sur le projet courant
|
||||
PROJECT_DIR="$(git rev-parse --show-toplevel)"
|
||||
TEMPLATE_DIR="$(cd "${PROJECT_DIR}/../4NK_template" && pwd)"
|
||||
|
||||
mkdir -p "${PROJECT_DIR}/tests/reports/agents"
|
||||
"${TEMPLATE_DIR}/scripts/local/run_agents_for_project.sh" "${PROJECT_DIR}" "tests/reports/agents"
|
||||
|
||||
# Audit sécurité (best effort) dans le contexte du projet
|
||||
if [ -f "${PROJECT_DIR}/scripts/security/audit.sh" ]; then
|
||||
(cd "${PROJECT_DIR}" && bash scripts/security/audit.sh) || true
|
||||
fi
|
||||
|
||||
# Release guard (dry-run logique) dans le contexte du projet
|
||||
if [ -f "${PROJECT_DIR}/scripts/release/guard.sh" ]; then
|
||||
(cd "${PROJECT_DIR}" && bash scripts/release/guard.sh) || true
|
||||
fi
|
||||
|
||||
echo "[pre-push] OK (agents via 4NK_template)"
|
20
scripts/local/release_local.sh
Executable file
20
scripts/local/release_local.sh
Executable file
@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="${1:-}"
|
||||
if [[ -z "$VERSION" ]]; then
|
||||
echo "Usage: $0 vYYYY.MM.P" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
cd "$ROOT_DIR/.."
|
||||
|
||||
echo "$VERSION" > TEMPLATE_VERSION
|
||||
git add TEMPLATE_VERSION CHANGELOG.md 2>/dev/null || true
|
||||
git commit -m "[skip ci] chore(release): $VERSION" || true
|
||||
git tag -a "$VERSION" -m "release: $VERSION (latest)"
|
||||
git push || true
|
||||
git push origin "$VERSION"
|
||||
|
||||
echo "Release locale préparée: $VERSION"
|
51
scripts/local/run_agents_for_project.sh
Executable file
51
scripts/local/run_agents_for_project.sh
Executable file
@ -0,0 +1,51 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Script pour lancer les agents de 4NK_template sur un projet externe
|
||||
# Usage: ./run_agents_for_project.sh [project_path] [output_dir]
|
||||
|
||||
PROJECT_PATH="${1:-.}"
|
||||
OUTPUT_DIR="${2:-tests/reports/agents}"
|
||||
TEMPLATE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
MODULE_LAST_IMAGE_FILE="$(cd "$TEMPLATE_DIR/.." && pwd)/modules/4NK_template/.last_image"
|
||||
|
||||
if [[ ! -d "$PROJECT_PATH" ]]; then
|
||||
echo "Erreur: Le projet '$PROJECT_PATH' n'existe pas" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
mkdir -p "$PROJECT_PATH/$OUTPUT_DIR"
|
||||
|
||||
echo "=== Lancement des agents 4NK_template sur: $PROJECT_PATH ==="
|
||||
|
||||
if ! command -v docker >/dev/null 2>&1; then
|
||||
echo "Docker requis pour exécuter les agents via conteneur." >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Si une image du module existe, l'utiliser en priorité
|
||||
if [[ -f "$MODULE_LAST_IMAGE_FILE" ]]; then
|
||||
IMAGE_NAME="$(cat "$MODULE_LAST_IMAGE_FILE" | tr -d '\r\n')"
|
||||
echo "Utilisation de l'image du module: $IMAGE_NAME"
|
||||
# Préparer montage du fichier d'env si présent
|
||||
ENV_MOUNT=""
|
||||
if [[ -f "$HOME/.4nk_template/.env" ]]; then
|
||||
ENV_MOUNT="-v $HOME/.4nk_template/.env:/root/.4nk_template/.env:ro"
|
||||
fi
|
||||
# Lancer le conteneur en utilisant l'ENTRYPOINT qui configure safe.directory
|
||||
docker run --rm \
|
||||
-e RUNNER_MODE=agents \
|
||||
-e TARGET_DIR=/work \
|
||||
-e OUTPUT_DIR=/work/$OUTPUT_DIR \
|
||||
-v "$(realpath "$PROJECT_PATH"):/work" \
|
||||
$ENV_MOUNT \
|
||||
"$IMAGE_NAME" || true
|
||||
else
|
||||
echo "Aucune image de module détectée, fallback docker compose dans 4NK_template"
|
||||
cd "$TEMPLATE_DIR"
|
||||
docker compose -f docker-compose.ci.yml build
|
||||
RUNNER_MODE="agents" TARGET_DIR="/work" OUTPUT_DIR="/work/$OUTPUT_DIR" \
|
||||
docker compose -f docker-compose.ci.yml run --rm project-ci || true
|
||||
fi
|
||||
|
||||
echo "=== Agents terminés → $PROJECT_PATH/$OUTPUT_DIR ==="
|
66
scripts/release/guard.sh
Executable file
66
scripts/release/guard.sh
Executable file
@ -0,0 +1,66 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Release guard script
|
||||
# Checks: tests, docs updated, compile, version ↔ changelog ↔ tag consistency, release type
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd)"
|
||||
cd "$ROOT_DIR"
|
||||
|
||||
mode="${RELEASE_TYPE:-ci-verify}" # values: latest | wip | ci-verify
|
||||
|
||||
echo "[release-guard] mode=$mode"
|
||||
|
||||
# 1) Basic presence checks
|
||||
[[ -f CHANGELOG.md ]] || { echo "CHANGELOG.md manquant"; exit 1; }
|
||||
version_file="VERSION"
|
||||
[[ -f TEMPLATE_VERSION ]] && version_file="TEMPLATE_VERSION"
|
||||
[[ -f "$version_file" ]] || { echo "$version_file manquant"; exit 1; }
|
||||
|
||||
# 2) Extract version
|
||||
project_version=$(tr -d '\r' < "$version_file" | head -n1 | sed 's/^v//')
|
||||
[[ -n "$project_version" ]] || { echo "Version vide dans $version_file"; exit 1; }
|
||||
echo "[release-guard] version=$project_version"
|
||||
|
||||
# 3) Changelog checks
|
||||
if ! grep -Eq "^## \\[$project_version\\]" CHANGELOG.md; then
|
||||
if [[ "$mode" == "wip" ]]; then
|
||||
grep -Eq "^## \\[Unreleased\\]" CHANGELOG.md || { echo "Section [Unreleased] absente du CHANGELOG"; exit 1; }
|
||||
else
|
||||
echo "Entrée CHANGELOG pour version $project_version manquante"; exit 1;
|
||||
fi
|
||||
fi
|
||||
|
||||
# 4) Tests (optional best-effort)
|
||||
if [[ -x tests/run_all_tests.sh ]]; then
|
||||
echo "[release-guard] exécution tests/run_all_tests.sh"
|
||||
./tests/run_all_tests.sh || { echo "Tests en échec"; exit 1; }
|
||||
else
|
||||
echo "[release-guard] tests absents (ok)"
|
||||
fi
|
||||
|
||||
# 5) Build/compile (optional based on project)
|
||||
if [[ -d sdk_relay ]] && command -v cargo >/dev/null 2>&1; then
|
||||
echo "[release-guard] cargo build (sdk_relay)"
|
||||
(cd sdk_relay && cargo build --quiet) || { echo "Compilation échouée"; exit 1; }
|
||||
else
|
||||
echo "[release-guard] build spécifique non applicable (ok)"
|
||||
fi
|
||||
|
||||
# 6) Release type handling
|
||||
case "$mode" in
|
||||
latest)
|
||||
;;
|
||||
wip)
|
||||
# En wip, autoriser versions suffixées; pas d’exigence d’entrée datée
|
||||
;;
|
||||
ci-verify)
|
||||
# En CI, on valide juste la présence de CHANGELOG et version
|
||||
;;
|
||||
*)
|
||||
echo "RELEASE_TYPE invalide: $mode (latest|wip|ci-verify)"; exit 1;
|
||||
;;
|
||||
esac
|
||||
|
||||
echo "[release-guard] OK"
|
||||
|
166
scripts/scripts/auto-ssh-push.sh
Executable file
166
scripts/scripts/auto-ssh-push.sh
Executable file
@ -0,0 +1,166 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Script d'automatisation des push SSH (template Linux)
|
||||
# Utilise automatiquement la clé SSH pour pousser sur le remote courant via SSH.
|
||||
|
||||
GITEA_HOST="${GITEA_HOST:-git.4nkweb.com}"
|
||||
|
||||
echo "🔑 Configuration SSH pour push (template)..."
|
||||
|
||||
# Configuration SSH automatique
|
||||
echo "⚙️ Configuration Git pour utiliser SSH..."
|
||||
git config --global url."git@${GITEA_HOST}:".insteadOf "https://${GITEA_HOST}/"
|
||||
|
||||
# Vérifier la configuration SSH
|
||||
echo "🔍 Vérification de la configuration SSH..."
|
||||
if ! ssh -T git@"${GITEA_HOST}" 2>&1 | grep -qi "authenticated\|welcome"; 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
|
||||
get_current_branch() {
|
||||
# Détecte la branche courante, compatible anciennes versions de git
|
||||
local br
|
||||
br="$(git rev-parse --abbrev-ref HEAD 2>/dev/null || true)"
|
||||
if [ -z "$br" ] || [ "$br" = "HEAD" ]; then
|
||||
br="$(git symbolic-ref --short -q HEAD 2>/dev/null || true)"
|
||||
fi
|
||||
if [ -z "$br" ]; then
|
||||
# dernier recours: parser la sortie de "git branch"
|
||||
br="$(git branch 2>/dev/null | sed -n 's/^* //p' | head -n1)"
|
||||
fi
|
||||
echo "$br"
|
||||
}
|
||||
|
||||
auto_push() {
|
||||
local branch
|
||||
branch=${1:-$(get_current_branch)}
|
||||
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 .
|
||||
|
||||
# Ne pas commiter si rien à commite
|
||||
if [[ -z "$(git diff --cached --name-only)" ]]; then
|
||||
echo "ℹ️ Aucun changement indexé. Skip commit/push."
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Commiter avec le message fourni
|
||||
git commit -m "$commit_message" || true
|
||||
|
||||
# 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:-$(get_current_branch)}
|
||||
|
||||
echo "💬 Push avec message: $message"
|
||||
auto_push "$branch" "$message"
|
||||
}
|
||||
|
||||
# Fonction pour push rapide (sans message)
|
||||
quick_push() {
|
||||
local branch=${1:-$(get_current_branch)}
|
||||
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:-$(get_current_branch)}
|
||||
local target_branch=${2:-main}
|
||||
|
||||
echo "🔄 Push et merge $source_branch -> $target_branch"
|
||||
|
||||
# Push de la branche source
|
||||
auto_push "$source_branch"
|
||||
|
||||
# Indication pour PR manuelle
|
||||
echo "🔗 Ouvrez une Pull Request sur votre forge pour $source_branch -> $target_branch"
|
||||
}
|
||||
|
||||
# Fonction pour status et push conditionnel
|
||||
status_and_push() {
|
||||
echo "📊 Statut du repository:"
|
||||
git status --short || true
|
||||
|
||||
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 (template)"
|
||||
echo ""
|
||||
echo "Options disponibles:"
|
||||
echo " auto-ssh-push.sh quick - Push rapide"
|
||||
echo " auto-ssh-push.sh message \"Mon message\" - Push avec message"
|
||||
echo " auto-ssh-push.sh branch nom-branche - Push sur branche spécifique"
|
||||
echo " auto-ssh-push.sh merge [source] [target] - Push et préparation merge"
|
||||
echo " auto-ssh-push.sh status - Status et push conditionnel"
|
||||
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" "${3:-}"
|
||||
;;
|
||||
"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é !"
|
60
scripts/scripts/init-ssh-env.sh
Executable file
60
scripts/scripts/init-ssh-env.sh
Executable file
@ -0,0 +1,60 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Script d'initialisation de l'environnement SSH (template Linux)
|
||||
# Configure automatiquement SSH pour les push via Gitea
|
||||
|
||||
GITEA_HOST="${GITEA_HOST:-git.4nkweb.com}"
|
||||
|
||||
echo "🚀 Initialisation de l'environnement SSH (template)..."
|
||||
|
||||
# Couleurs
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m'
|
||||
|
||||
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"; }
|
||||
|
||||
print_status "Configuration SSH..."
|
||||
|
||||
# 1. Configuration Git pour SSH
|
||||
print_status "Configuration Git pour utiliser SSH (${GITEA_HOST})..."
|
||||
git config --global url."git@${GITEA_HOST}:".insteadOf "https://${GITEA_HOST}/"
|
||||
|
||||
# 2. Vérification des clés SSH
|
||||
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"
|
||||
else
|
||||
print_warning "Aucune clé SSH trouvée"
|
||||
fi
|
||||
|
||||
# 3. Test de la connexion SSH
|
||||
print_status "Test de la connexion SSH vers ${GITEA_HOST}..."
|
||||
if ssh -T git@"${GITEA_HOST}" 2>&1 | grep -qi "authenticated\|welcome"; then
|
||||
print_success "Authentification SSH réussie"
|
||||
else
|
||||
print_error "Échec de l'authentification SSH"
|
||||
fi
|
||||
|
||||
# 4. 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. Rendu exécutable des scripts si chemin standard
|
||||
print_status "Configuration des permissions des scripts (si présents)..."
|
||||
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 (si présents)"
|
||||
|
||||
# 6. Résumé
|
||||
echo ""
|
||||
print_success "=== Configuration SSH terminée ==="
|
||||
|
55
scripts/scripts/setup-ssh-ci.sh
Executable file
55
scripts/scripts/setup-ssh-ci.sh
Executable file
@ -0,0 +1,55 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Script de configuration SSH pour CI/CD (template Linux)
|
||||
# Utilise automatiquement la clé SSH pour les opérations Git
|
||||
|
||||
GITEA_HOST="${GITEA_HOST:-git.4nkweb.com}"
|
||||
|
||||
echo "🔑 Configuration automatique de la clé SSH pour CI/CD..."
|
||||
|
||||
if [ -n "${CI:-}" ]; then
|
||||
echo "✅ Environnement CI détecté"
|
||||
|
||||
if [ -n "${SSH_PRIVATE_KEY:-}" ]; then
|
||||
echo "🔐 Configuration de la clé SSH privée..."
|
||||
mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||
printf "%s" "$SSH_PRIVATE_KEY" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
|
||||
if [ -n "${SSH_PUBLIC_KEY:-}" ]; then
|
||||
printf "%s" "$SSH_PUBLIC_KEY" > ~/.ssh/id_rsa.pub
|
||||
chmod 644 ~/.ssh/id_rsa.pub
|
||||
fi
|
||||
|
||||
cat > ~/.ssh/config << EOF
|
||||
Host ${GITEA_HOST}
|
||||
HostName ${GITEA_HOST}
|
||||
User git
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
StrictHostKeyChecking no
|
||||
UserKnownHostsFile=/dev/null
|
||||
EOF
|
||||
chmod 600 ~/.ssh/config
|
||||
|
||||
echo "🧪 Test SSH vers ${GITEA_HOST}..."
|
||||
ssh -T git@"${GITEA_HOST}" 2>&1 || true
|
||||
|
||||
git config --global url."git@${GITEA_HOST}:".insteadOf "https://${GITEA_HOST}/"
|
||||
echo "✅ Configuration SSH terminée"
|
||||
else
|
||||
echo "⚠️ SSH_PRIVATE_KEY non défini, bascule HTTPS"
|
||||
fi
|
||||
else
|
||||
echo "ℹ️ Environnement local détecté"
|
||||
if [ -f ~/.ssh/id_rsa ] || [ -f ~/.ssh/id_ed25519 ]; then
|
||||
echo "🔑 Clé SSH locale trouvée"
|
||||
git config --global url."git@${GITEA_HOST}:".insteadOf "https://${GITEA_HOST}/"
|
||||
echo "✅ Configuration SSH locale terminée"
|
||||
else
|
||||
echo "⚠️ Aucune clé SSH trouvée; configuration manuelle requise"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "🎯 Configuration SSH CI/CD terminée"
|
||||
|
35
scripts/security/audit.sh
Executable file
35
scripts/security/audit.sh
Executable file
@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
echo "[security-audit] démarrage"
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd)"
|
||||
cd "$ROOT_DIR"
|
||||
|
||||
rc=0
|
||||
|
||||
# 1) Audit Rust (si Cargo.toml présent et cargo disponible)
|
||||
if command -v cargo >/dev/null 2>&1 && [ -f Cargo.toml ] || find . -maxdepth 2 -name Cargo.toml | grep -q . ; then
|
||||
echo "[security-audit] cargo audit"
|
||||
if ! cargo audit --deny warnings; then rc=1; fi || true
|
||||
else
|
||||
echo "[security-audit] pas de projet Rust (ok)"
|
||||
fi
|
||||
|
||||
# 2) Audit npm (si package.json présent)
|
||||
if [ -f package.json ]; then
|
||||
echo "[security-audit] npm audit --audit-level=moderate"
|
||||
if ! npm audit --audit-level=moderate; then rc=1; fi || true
|
||||
else
|
||||
echo "[security-audit] pas de package.json (ok)"
|
||||
fi
|
||||
|
||||
# 3) Recherche de secrets grossiers
|
||||
echo "[security-audit] scan secrets"
|
||||
if grep -RIE "(?i)(api[_-]?key|secret|password|private[_-]?key)" --exclude-dir .git --exclude-dir node_modules --exclude-dir target --exclude "*.md" . >/dev/null 2>&1; then
|
||||
echo "[security-audit] secrets potentiels détectés"; rc=1
|
||||
else
|
||||
echo "[security-audit] aucun secret évident"
|
||||
fi
|
||||
|
||||
echo "[security-audit] terminé rc=$rc"
|
||||
exit $rc
|
80
scripts/setup-ssh-ci.sh
Executable file
80
scripts/setup-ssh-ci.sh
Executable file
@ -0,0 +1,80 @@
|
||||
#!/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"
|
||||
|
47
scripts/utils/check_md024.ps1
Normal file
47
scripts/utils/check_md024.ps1
Normal file
@ -0,0 +1,47 @@
|
||||
Param(
|
||||
[string]$Root = "."
|
||||
)
|
||||
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
$files = Get-ChildItem -Path $Root -Recurse -Filter *.md | Where-Object { $_.FullName -notmatch '\\archive\\' }
|
||||
$had = $false
|
||||
foreach ($f in $files) {
|
||||
try {
|
||||
$lines = Get-Content -LiteralPath $f.FullName -Encoding UTF8 -ErrorAction Stop
|
||||
} catch {
|
||||
Write-Warning ("Impossible de lire: {0} — {1}" -f $f.FullName, $_.Exception.Message)
|
||||
continue
|
||||
}
|
||||
$map = @{}
|
||||
$firstMap = @{}
|
||||
$dups = @{}
|
||||
for ($i = 0; $i -lt $lines.Count; $i++) {
|
||||
$line = $lines[$i]
|
||||
if ($line -match '^\s{0,3}#{1,6}\s+(.*)$') {
|
||||
$t = $Matches[1].Trim()
|
||||
$norm = ([regex]::Replace($t, '\s+', ' ')).ToLowerInvariant()
|
||||
if ($map.ContainsKey($norm)) {
|
||||
if (-not $dups.ContainsKey($norm)) {
|
||||
$dups[$norm] = New-Object System.Collections.ArrayList
|
||||
$firstMap[$norm] = $map[$norm]
|
||||
}
|
||||
[void]$dups[$norm].Add($i + 1)
|
||||
} else {
|
||||
$map[$norm] = $i + 1
|
||||
}
|
||||
}
|
||||
}
|
||||
if ($dups.Keys.Count -gt 0) {
|
||||
$had = $true
|
||||
Write-Output "=== $($f.FullName) ==="
|
||||
foreach ($k in $dups.Keys) {
|
||||
$first = $firstMap[$k]
|
||||
$others = ($dups[$k] -join ', ')
|
||||
Write-Output ("Heading: '{0}' first@{1} duplicates@[{2}]" -f $k, $first, $others)
|
||||
}
|
||||
}
|
||||
}
|
||||
if (-not $had) {
|
||||
Write-Output "No duplicate headings detected."
|
||||
}
|
69
src/crypto.rs
Normal file
69
src/crypto.rs
Normal file
@ -0,0 +1,69 @@
|
||||
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))
|
||||
}
|
185
src/device.rs
Normal file
185
src/device.rs
Normal file
@ -0,0 +1,185 @@
|
||||
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_mut_sp_wallet(&mut self) -> &mut SpWallet {
|
||||
&mut 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
Normal file
41
src/error.rs
Normal file
@ -0,0 +1,41 @@
|
||||
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
Normal file
24
src/hash.rs
Normal file
@ -0,0 +1,24 @@
|
||||
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,3 +1,129 @@
|
||||
pub mod models;
|
||||
pub mod wallet;
|
||||
pub mod workflows;
|
||||
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 flate2;
|
||||
|
||||
#[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)"))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,5 +0,0 @@
|
||||
use sdk_common::models;
|
||||
use sdk_common::wallet;
|
||||
use sdk_common::workflows;
|
||||
|
||||
fn main() {}
|
@ -1,11 +0,0 @@
|
||||
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 }
|
||||
}
|
||||
}
|
@ -1,25 +0,0 @@
|
||||
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
|
||||
}
|
||||
}
|
@ -1,23 +0,0 @@
|
||||
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
|
||||
}
|
||||
}
|
@ -1,24 +0,0 @@
|
||||
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
|
||||
}
|
||||
}
|
@ -1,19 +0,0 @@
|
||||
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);
|
||||
}
|
||||
}
|
@ -1,25 +0,0 @@
|
||||
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
|
||||
}
|
||||
}
|
@ -1,141 +0,0 @@
|
||||
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.
|
||||
}
|
@ -1,49 +0,0 @@
|
||||
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);
|
||||
}
|
||||
}
|
@ -1,8 +0,0 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||||
|
||||
pub struct DepositMethod {
|
||||
pub method: String,
|
||||
}
|
||||
impl DepositMethod {}
|
@ -1,94 +0,0 @@
|
||||
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
|
||||
}
|
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