diff --git a/docs/API.md b/docs/API.md index 7fe48e9..18ae1b9 100644 --- a/docs/API.md +++ b/docs/API.md @@ -150,7 +150,7 @@ Les types membres, rôles, clés, engagements PCD et transactions s’appuient s #### Méthode Cookie (Recommandée) ```bash -# Le cookie est automatiquement utilisé par Bitcoin Core +## Le cookie est automatiquement utilisé par Bitcoin Core curl -X POST http://localhost:18443 \ -H "Content-Type: application/json" \ --data '{"jsonrpc": "1.0", "id": "test", "method": "getblockchaininfo", "params": []}' @@ -806,7 +806,7 @@ ws.onmessage = function(event) { ### Exemple cURL - Bitcoin Core RPC ```bash -# Récupérer les informations de la blockchain +## Récupérer les informations de la blockchain curl -X POST http://localhost:18443 \ -H "Content-Type: application/json" \ --data '{ @@ -816,7 +816,7 @@ curl -X POST http://localhost:18443 \ "params": [] }' -# Récupérer un bloc spécifique +## Récupérer un bloc spécifique curl -X POST http://localhost:18443 \ -H "Content-Type: application/json" \ --data '{ diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index e1bc6e3..f1f7b6d 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -290,15 +290,15 @@ services: Chaque relais a sa propre configuration : ```ini -# .conf.docker.relay1 +## .conf.docker.relay1 relay_id=relay-1 ws_url=0.0.0.0:8090 -# .conf.docker.relay2 +## .conf.docker.relay2 relay_id=relay-2 ws_url=0.0.0.0:8090 -# .conf.docker.relay3 +## .conf.docker.relay3 relay_id=relay-3 ws_url=0.0.0.0:8090 ``` 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 44bf5cd..98377a9 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -42,7 +42,7 @@ La configuration de build et les variantes de profils sont décrites dans `docs/ ### 2. Configuration de Build ```toml -# Cargo.toml +## Cargo.toml [profile.release] opt-level = 3 lto = true @@ -76,13 +76,13 @@ use lru::LruCache; ### 2. Optimisations WASM ```bash -# Build optimisé +## Build optimisé wasm-pack build --target web --release -# Optimisation de la taille +## Optimisation de la taille wasm-opt -O4 pkg/sdk_client_bg.wasm -o pkg/sdk_client_bg_opt.wasm -# Compression gzip +## Compression gzip gzip -9 pkg/sdk_client_bg_opt.wasm ``` @@ -160,54 +160,54 @@ use checked_add::CheckedAdd; ### 1. Problèmes de Compilation ```bash -# Nettoyer et recompiler +## Nettoyer et recompiler cargo clean cargo build -# Vérifier les dépendances +## Vérifier les dépendances cargo update cargo check -# Vérifier les features +## Vérifier les features cargo build --features wasm ``` ### 2. Problèmes WASM ```bash -# Nettoyer WASM +## Nettoyer WASM rm -rf pkg/ wasm-pack build --target web -# Vérifier la compatibilité +## Vérifier la compatibilité wasm-pack test --headless --firefox -# Debug WASM +## Debug WASM RUST_LOG=debug wasm-pack build --target web ``` ### 3. Problèmes de Performance ```bash -# Profiling Rust +## Profiling Rust cargo build --release perf record ./target/release/sdk_client perf report -# Profiling WASM +## Profiling WASM wasm-pack build --target web --profiling ``` ### 4. Logs et Debugging ```bash -# Logs détaillés +## Logs détaillés RUST_LOG=debug cargo test -# Logs spécifiques +## Logs spécifiques RUST_LOG=sdk_client::wallet=debug cargo test -# Backtrace +## Backtrace RUST_BACKTRACE=1 cargo test ```