diff --git a/docs/API.md b/docs/API.md index 1c3e281..0e0cad2 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,4 +1,4 @@ -# Référence API - sdk_common +## Référence API - sdk_common Ce guide documente toutes les APIs disponibles dans la bibliothèque commune sdk_common pour les Silent Payments. @@ -294,10 +294,10 @@ sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["f ### Variables d'Environnement ```bash -# Niveau de log +## Niveau de log RUST_LOG=debug -# Configuration de compression +## Configuration de compression COMPRESSION_LEVEL=6 ``` @@ -305,10 +305,10 @@ COMPRESSION_LEVEL=6 ### Tests Unitaires ```bash -# Tous les tests +## Tous les tests cargo test -# Tests spécifiques +## Tests spécifiques cargo test compression cargo test validation cargo test serialization @@ -316,7 +316,7 @@ cargo test serialization ### Tests d'Intégration ```bash -# Tests d'intégration +## Tests d'intégration cargo test --test integration_tests ``` diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 19e3f04..5cac117 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -1,4 +1,4 @@ -# Architecture Technique - sdk_common +## 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. diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md new file mode 100644 index 0000000..6f48af9 --- /dev/null +++ b/docs/DEPLOYMENT.md @@ -0,0 +1,9 @@ +## DEPLOYMENT + +### Docker + +### Intégration dans 4NK_node + +### CI/CD appliquée + +### Configuration diff --git a/docs/SSH_USAGE.md b/docs/SSH_USAGE.md index f2ed31c..53c238b 100644 --- a/docs/SSH_USAGE.md +++ b/docs/SSH_USAGE.md @@ -1,4 +1,4 @@ -# Documentation SSH complète - ihm_client +## Documentation SSH complète - ihm_client ## Vue d'ensemble @@ -44,19 +44,19 @@ Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique : #### Options disponibles ```bash -# Push rapide (message automatique) +## Push rapide (message automatique) ./scripts/auto-ssh-push.sh quick -# Push avec message personnalisé +## Push avec message personnalisé ./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité" -# Push sur une branche spécifique +## Push sur une branche spécifique ./scripts/auto-ssh-push.sh branch feature/nouvelle-fonctionnalite -# Push et merge (avec confirmation) +## Push et merge (avec confirmation) ./scripts/auto-ssh-push.sh merge -# Vérification du statut +## Vérification du statut ./scripts/auto-ssh-push.sh status ``` @@ -136,20 +136,20 @@ Le workflow CI/CD dans `.gitea/workflows/ci.yml` inclut une étape de configurat ### Alias configurés ```bash -# Push rapide avec message automatique +## Push rapide avec message automatique git quick-push -# Push avec message personnalisé +## Push avec message personnalisé git ssh-push "Mon message de commit" ``` ### Configuration des alias ```bash -# Alias pour push rapide +## 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 +## 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' ``` @@ -211,33 +211,33 @@ git config --global alias.ssh-push '!f() { git add . && git commit -m "${1:-Auto #### 1. Échec d'authentification SSH ```bash -# Vérifier la configuration SSH +## Vérifier la configuration SSH ssh -T git@git.4nkweb.com -# Vérifier les permissions +## Vérifier les permissions ls -la ~/.ssh/ -# Régénérer la clé SSH si nécessaire +## 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 +## Vérifier la configuration Git git config --global --list | grep url -# Reconfigurer SSH +## 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 +## Vérifier les variables d'environnement echo $SSH_PRIVATE_KEY -# Tester la configuration SSH +## Tester la configuration SSH ./scripts/setup-ssh-ci.sh ``` @@ -250,10 +250,10 @@ echo $SSH_PRIVATE_KEY ### Logs et debugging ```bash -# Activer le debug SSH +## Activer le debug SSH ssh -vT git@git.4nkweb.com -# Vérifier les logs Git +## Vérifier les logs Git GIT_SSH_COMMAND="ssh -v" git push origin main ``` @@ -273,10 +273,10 @@ Le projet `ihm_client` est configuré pour s'intégrer dans l'infrastructure `4N ### Workflow d'intégration ```bash -# Intégrer ihm_client dans 4NK_node +## Intégrer ihm_client dans 4NK_node ./scripts/integrate-4nk-node.sh -# Vérifier l'intégration +## Vérifier l'intégration docker-compose -f docker-compose.4nk-node.yml up -d ``` diff --git a/docs/USAGE.md b/docs/USAGE.md index dd12444..b532dce 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -1,4 +1,4 @@ -# 📖 Guide d'Utilisation - sdk_common +## 📖 Guide d'Utilisation - sdk_common Guide complet pour utiliser la bibliothèque commune sdk_common pour les Silent Payments. @@ -7,26 +7,26 @@ Guide complet pour utiliser la bibliothèque commune sdk_common pour les Silent ### 1. Build de Développement ```bash -# Build de base +## Build de base cargo build -# Build avec toutes les features +## Build avec toutes les features cargo build --all-features -# Build avec une feature spécifique +## Build avec une feature spécifique cargo build --features flate2 ``` ### 2. Build de Production ```bash -# Build optimisé +## Build optimisé cargo build --release -# Build avec optimisations avancées +## Build avec optimisations avancées RUSTFLAGS="-C target-cpu=native" cargo build --release -# Build avec LTO +## Build avec LTO RUSTFLAGS="-C lto=fat" cargo build --release ``` @@ -40,7 +40,7 @@ RUSTFLAGS="-C lto=fat" cargo build --release [dependencies] sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", branch = "docker-support" } -# Avec features spécifiques +## Avec features spécifiques sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["flate2"] } ``` @@ -253,10 +253,10 @@ sdk_common = { git = "https://git.4nkweb.com/4nk/sdk_common.git", features = ["f ### Variables d'Environnement ```bash -# Niveau de log +## Niveau de log export RUST_LOG=debug -# Configuration de compression +## Configuration de compression export COMPRESSION_LEVEL=6 ``` @@ -323,10 +323,10 @@ fn create_process_list(count: usize) -> Vec { ### Benchmarks ```bash -# Tests de performance +## Tests de performance cargo bench -# Tests de compression +## Tests de compression cargo test compression_benchmark ``` @@ -373,21 +373,21 @@ fn handle_sensitive_data(data: &[u8]) -> Result<(), SdkError> { ### Workflow de Développement ```bash -# 1. Cloner le projet +## 1. Cloner le projet git clone https://git.4nkweb.com/4nk/sdk_common.git cd sdk_common -# 2. Installer les dépendances +## 2. Installer les dépendances cargo build -# 3. Lancer les tests +## 3. Lancer les tests cargo test -# 4. Vérifier le code +## 4. Vérifier le code cargo clippy -- -D warnings cargo fmt -- --check -# 5. Générer la documentation +## 5. Générer la documentation cargo doc --open ```