4nk/sdk_client
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: normalisation titres H2 et mises à jour

Browse Source
This commit is contained in:
Debian 2025-09-03 08:14:56 +00:00
parent 35c6b1b61d
commit 6613aaabd9
5 changed files with 51 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/API.md
View File

@ -150,7 +150,7 @@ Les types membres, rôles, clés, engagements PCD et transactions s’appuient s
#### Méthode Cookie (Recommandée) #### Méthode Cookie (Recommandée)
```bash ```bash
# Le cookie est automatiquement utilisé par Bitcoin Core ## Le cookie est automatiquement utilisé par Bitcoin Core
curl -X POST http://localhost:18443 \ curl -X POST http://localhost:18443 \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
--data '{"jsonrpc": "1.0", "id": "test", "method": "getblockchaininfo", "params": []}' --data '{"jsonrpc": "1.0", "id": "test", "method": "getblockchaininfo", "params": []}'
@ -806,7 +806,7 @@ ws.onmessage = function(event) {
### Exemple cURL - Bitcoin Core RPC ### Exemple cURL - Bitcoin Core RPC
```bash ```bash
# Récupérer les informations de la blockchain ## Récupérer les informations de la blockchain
curl -X POST http://localhost:18443 \ curl -X POST http://localhost:18443 \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
--data '{ --data '{
@ -816,7 +816,7 @@ curl -X POST http://localhost:18443 \
"params": [] "params": []
}' }'
# Récupérer un bloc spécifique ## Récupérer un bloc spécifique
curl -X POST http://localhost:18443 \ curl -X POST http://localhost:18443 \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
--data '{ --data '{

6
docs/ARCHITECTURE.md
View File

@ -290,15 +290,15 @@ services:
Chaque relais a sa propre configuration : Chaque relais a sa propre configuration :
```ini ```ini
# .conf.docker.relay1 ## .conf.docker.relay1
relay_id=relay-1 relay_id=relay-1
ws_url=0.0.0.0:8090 ws_url=0.0.0.0:8090
# .conf.docker.relay2 ## .conf.docker.relay2
relay_id=relay-2 relay_id=relay-2
ws_url=0.0.0.0:8090 ws_url=0.0.0.0:8090
# .conf.docker.relay3 ## .conf.docker.relay3
relay_id=relay-3 relay_id=relay-3
ws_url=0.0.0.0:8090 ws_url=0.0.0.0:8090
``` ```

9
docs/DEPLOYMENT.md Normal file
View File

@ -0,0 +1,9 @@
## DEPLOYMENT
### Docker
### Intégration dans 4NK_node
### CI/CD appliquée
### Configuration

42
docs/SSH_USAGE.md
View File

@ -1,4 +1,4 @@
# Documentation SSH complète - ihm_client ## Documentation SSH complète - ihm_client
## Vue d'ensemble ## Vue d'ensemble
@ -44,19 +44,19 @@ Le script `scripts/auto-ssh-push.sh` offre plusieurs modes de push automatique :
#### Options disponibles #### Options disponibles
```bash ```bash
# Push rapide (message automatique) ## Push rapide (message automatique)
./scripts/auto-ssh-push.sh quick ./scripts/auto-ssh-push.sh quick
# Push avec message personnalisé ## Push avec message personnalisé
./scripts/auto-ssh-push.sh message "feat: nouvelle fonctionnalité" ./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 ./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 ./scripts/auto-ssh-push.sh merge
# Vérification du statut ## Vérification du statut
./scripts/auto-ssh-push.sh status ./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 ### Alias configurés
```bash ```bash
# Push rapide avec message automatique ## Push rapide avec message automatique
git quick-push git quick-push
# Push avec message personnalisé ## Push avec message personnalisé
git ssh-push "Mon message de commit" git ssh-push "Mon message de commit"
``` ```
### Configuration des alias ### Configuration des alias
```bash ```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' 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' 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 #### 1. Échec d'authentification SSH
```bash ```bash
# Vérifier la configuration SSH ## Vérifier la configuration SSH
ssh -T git@git.4nkweb.com ssh -T git@git.4nkweb.com
# Vérifier les permissions ## Vérifier les permissions
ls -la ~/.ssh/ 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 ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519_4nk
``` ```
#### 2. Configuration Git incorrecte #### 2. Configuration Git incorrecte
```bash ```bash
# Vérifier la configuration Git ## Vérifier la configuration Git
git config --global --list | grep url git config --global --list | grep url
# Reconfigurer SSH ## Reconfigurer SSH
git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/" git config --global url."git@git.4nkweb.com:".insteadOf "https://git.4nkweb.com/"
``` ```
#### 3. Problèmes CI/CD #### 3. Problèmes CI/CD
```bash ```bash
# Vérifier les variables d'environnement ## Vérifier les variables d'environnement
echo $SSH_PRIVATE_KEY echo $SSH_PRIVATE_KEY
# Tester la configuration SSH ## Tester la configuration SSH
./scripts/setup-ssh-ci.sh ./scripts/setup-ssh-ci.sh
``` ```
@ -250,10 +250,10 @@ echo $SSH_PRIVATE_KEY
### Logs et debugging ### Logs et debugging
```bash ```bash
# Activer le debug SSH ## Activer le debug SSH
ssh -vT git@git.4nkweb.com 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 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 ### Workflow d'intégration
```bash ```bash
# Intégrer ihm_client dans 4NK_node ## Intégrer ihm_client dans 4NK_node
./scripts/integrate-4nk-node.sh ./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 docker-compose -f docker-compose.4nk-node.yml up -d
``` ```

30
docs/USAGE.md
View File

@ -42,7 +42,7 @@ La configuration de build et les variantes de profils sont décrites dans `docs/
### 2. Configuration de Build ### 2. Configuration de Build
```toml ```toml
# Cargo.toml ## Cargo.toml
[profile.release] [profile.release]
opt-level = 3 opt-level = 3
lto = true lto = true
@ -76,13 +76,13 @@ use lru::LruCache;
### 2. Optimisations WASM ### 2. Optimisations WASM
```bash ```bash
# Build optimisé ## Build optimisé
wasm-pack build --target web --release 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 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 gzip -9 pkg/sdk_client_bg_opt.wasm
``` ```
@ -160,54 +160,54 @@ use checked_add::CheckedAdd;
### 1. Problèmes de Compilation ### 1. Problèmes de Compilation
```bash ```bash
# Nettoyer et recompiler ## Nettoyer et recompiler
cargo clean cargo clean
cargo build cargo build
# Vérifier les dépendances ## Vérifier les dépendances
cargo update cargo update
cargo check cargo check
# Vérifier les features ## Vérifier les features
cargo build --features wasm cargo build --features wasm
``` ```
### 2. Problèmes WASM ### 2. Problèmes WASM
```bash ```bash
# Nettoyer WASM ## Nettoyer WASM
rm -rf pkg/ rm -rf pkg/
wasm-pack build --target web wasm-pack build --target web
# Vérifier la compatibilité ## Vérifier la compatibilité
wasm-pack test --headless --firefox wasm-pack test --headless --firefox
# Debug WASM ## Debug WASM
RUST_LOG=debug wasm-pack build --target web RUST_LOG=debug wasm-pack build --target web
``` ```
### 3. Problèmes de Performance ### 3. Problèmes de Performance
```bash ```bash
# Profiling Rust ## Profiling Rust
cargo build --release cargo build --release
perf record ./target/release/sdk_client perf record ./target/release/sdk_client
perf report perf report
# Profiling WASM ## Profiling WASM
wasm-pack build --target web --profiling wasm-pack build --target web --profiling
``` ```
### 4. Logs et Debugging ### 4. Logs et Debugging
```bash ```bash
# Logs détaillés ## Logs détaillés
RUST_LOG=debug cargo test RUST_LOG=debug cargo test
# Logs spécifiques ## Logs spécifiques
RUST_LOG=sdk_client::wallet=debug cargo test RUST_LOG=sdk_client::wallet=debug cargo test
# Backtrace ## Backtrace
RUST_BACKTRACE=1 cargo test RUST_BACKTRACE=1 cargo test
``` ```