docs: add architecture, installation, deployment, functional, technical, flows, quality, security, TODO [skip ci]

This commit is contained in:
4NK Dev 2025-09-22 07:32:52 +00:00
parent a38c5877bf
commit 753e4c6a3e
9 changed files with 121 additions and 0 deletions

20
docs/ARCHITECTURE.md Normal file
View File

@ -0,0 +1,20 @@
# Architecture - SDK Relay
## Composants
- Service Rust WebSocket relay + intégration Bitcoin/BlindBit.
## Dépendances
- `bitcoin` (RPC/ZMQ), `blindbit-proxy`, `sdk_storage`.
## Réseau et ports
- WS: `0.0.0.0:8090` (exposé derrière Nginx `wss://dev4.4nkweb.com/ws/`).
## Variables denvironnement (centralisées)
- `SDK_RELAY_*` depuis `lecoffre_node/.env.master`.
## Monitoring
- Healthcheck avec progression IBD/attentes.
- Logs centralisés Loki/Grafana (SDK Services).
## Notes
- Démarre après Bitcoin et BlindBit.

21
docs/DEPLOIEMENT.md Normal file
View File

@ -0,0 +1,21 @@
# Déploiement - SDK Relay
## Préparation
- Branche `ext`.
- `SDK_RELAY_*` dans `lecoffre_node/.env.master`.
- Accès `bitcoin` RPC/ZMQ et `blindbit-proxy`.
## Déploiement (orchestrateur)
```bash
cd /home/debian/4NK_env/lecoffre_node
./scripts/start.sh | cat
./scripts/validate-deployment.sh | cat
```
## Vérifications
- WS: `wss://dev4.4nkweb.com/ws/`.
- `./scripts/monitor-progress.sh | cat` (attente IBD/BlindBit).
## Règles
- Pas de compose direct.
- Push `ext` sans CI si pas de binaire à reconstruire.

6
docs/FLUX.md Normal file
View File

@ -0,0 +1,6 @@
# Description des Flux - SDK Relay
## Flux principaux
1. Bitcoin (RPC/ZMQ) → Relay (indexation, signaux IBD).
2. BlindBit → Relay (résolution secrets SP).
3. Clients WS ↔ Relay (évènements NewTx, notifications).

13
docs/FONCTIONNEL.md Normal file
View File

@ -0,0 +1,13 @@
# Description Fonctionnelle - SDK Relay
## Objectif
Assurer le relais temps réel WebSocket et lorchestration des évènements blockchain (Bitcoin/BlindBit) pour les services applicatifs.
## Parcours clés
- Abonnement clients WS.
- Relais dévènements (nouveaux blocs, transactions, notifications NewTx).
- Attente synchronisation Bitcoin et disponibilité BlindBit avant diffusion.
## Résultats attendus
- Canal temps réel fiable.
- Mise en file dattente/retente en cas dindisponibilité dépendances.

24
docs/INSTALLATION.md Normal file
View File

@ -0,0 +1,24 @@
# Installation - SDK Relay
## Prérequis
- Dépôts sous `/home/debian/4NK_env` (branche `ext`).
- Docker/Compose.
- Variables `SDK_RELAY_*` dans `lecoffre_node/.env.master`.
## Configuration
- Pas de `.env` local.
- Vérifier accès `bitcoin` (RPC/ZMQ) et `blindbit-proxy`.
## Démarrage (orchestrateur)
```bash
cd /home/debian/4NK_env/lecoffre_node
./scripts/start.sh | cat
```
## Vérifications
- WS: `wss://dev4.4nkweb.com/ws/`
- Health: scripts `monitor-progress.sh`, `logs-with-progress.sh`.
## Notes
- Démarre après Bitcoin et BlindBit.
- CI via tag `ext`.

6
docs/QUALITE.md Normal file
View File

@ -0,0 +1,6 @@
# Qualité Logicielle - SDK Relay
- Lint/format: Rustfmt/Clippy.
- Tests: unitaires, intégration WS, tests de charge.
- Performance: backpressure WS, gestion erreurs.
- Observabilité: logs structurés, métriques si dispo.

6
docs/SECURITE.md Normal file
View File

@ -0,0 +1,6 @@
# Sécurité - SDK Relay
- Aucune clé ou secret en dur.
- Accès Bitcoin RPC/ZMQ sécurisés sur réseau interne Docker.
- Validation stricte des messages WS.
- Journaux sans secrets.

19
docs/TECHNIQUE.md Normal file
View File

@ -0,0 +1,19 @@
# Description Technique - SDK Relay
## Tech stack
- Rust, WebSocket server.
## Configuration
- Variables `SDK_RELAY_*` via `lecoffre_node/.env.master`.
- Connexion Bitcoin (RPC/ZMQ), BlindBit URL.
## Interfaces
- WS `0.0.0.0:8090` (derrière Nginx).
## Sécurité
- Aucun secret en dur.
- Validation stricte des messages.
## Observabilité
- Healthcheck avec progression.
- Logs Loki/Grafana.

6
docs/TODO.md Normal file
View File

@ -0,0 +1,6 @@
# TODO - SDK Relay
- Vérifier connexion Bitcoin (RPC/ZMQ) et BlindBit.
- Tester WebSocket public via Nginx.
- Valider healthchecks et progression IBD.
- Surveiller logs et mettre en place alertes Grafana.