Compare commits
No commits in common. "063161a9eeadba1d98821494e1b9cde17f14b4c2" and "19ab0f2f059261529e296faed2ef69d2cef7e71a" have entirely different histories.
063161a9ee
...
19ab0f2f05
@ -1,17 +0,0 @@
|
||||
# Note de Déploiement
|
||||
|
||||
⚠️ **IMPORTANT**: Ce dossier `lecoffre-anchor-api` **NE DOIT PAS** être déployé par `deploy-remote.sh`.
|
||||
|
||||
## Pourquoi ?
|
||||
|
||||
- Ce dossier est déployé sur le serveur : `dev3.4nkweb.com` (node Bitcoin)
|
||||
- Le backend principal (`lecoffre-back-main`) et le frontend (`lecoffre-front-main`) sont sur `local.4nkweb.com`
|
||||
- L'API d'ancrage nécessite un accès direct au nœud Bitcoin Signet
|
||||
|
||||
## Déploiement
|
||||
|
||||
Utiliser le script dédié:
|
||||
|
||||
```bash
|
||||
./deploy-anchor-api.sh
|
||||
```
|
||||
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,21 +0,0 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
|
||||
# Build
|
||||
dist/
|
||||
|
||||
# Environment
|
||||
.env
|
||||
|
||||
# Logs
|
||||
logs/
|
||||
*.log
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
382
API_RESPONSES.md
382
API_RESPONSES.md
@ -1,382 +0,0 @@
|
||||
# Documentation des Réponses JSON - LeCoffre Anchor API
|
||||
|
||||
## 📋 Vue d'ensemble
|
||||
|
||||
L'API d'ancrage Bitcoin Signet retourne des réponses JSON standardisées. Le `transaction_id` est maintenant directement le `txid` Bitcoin (64 caractères hexadécimaux), consultable sur mempool.
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Endpoints et Réponses
|
||||
|
||||
### 1. GET `/health`
|
||||
|
||||
**Description** : Vérifie l'état de santé de l'API et la connexion Bitcoin.
|
||||
|
||||
**Réponse 200 OK** :
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"service": "anchor-api",
|
||||
"bitcoin": {
|
||||
"connected": true,
|
||||
"blocks": 141690,
|
||||
"network": "signet",
|
||||
"explorer": "mempool2.4nkweb.com"
|
||||
},
|
||||
"context": {
|
||||
"api_version": "1.0.0",
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/",
|
||||
"status": "operational"
|
||||
},
|
||||
"timestamp": "2025-11-14T10:30:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 503 Service Unavailable** (si Bitcoin non connecté) :
|
||||
```json
|
||||
{
|
||||
"ok": false,
|
||||
"service": "anchor-api",
|
||||
"error": "Bitcoin connection failed",
|
||||
"timestamp": "2025-11-14T10:30:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
**Champs** :
|
||||
- `ok` : `boolean` - État général de l'API
|
||||
- `service` : `string` - Nom du service
|
||||
- `bitcoin.connected` : `boolean` - État de la connexion Bitcoin
|
||||
- `bitcoin.blocks` : `number` - Nombre de blocs dans la blockchain
|
||||
- `bitcoin.network` : `string` - Réseau Bitcoin (signet)
|
||||
- `bitcoin.explorer` : `string` - URL de l'explorateur
|
||||
- `context.status` : `"operational" | "degraded"` - État opérationnel
|
||||
- `timestamp` : `string` - ISO 8601 timestamp
|
||||
|
||||
---
|
||||
|
||||
### 2. POST `/api/anchor/document`
|
||||
|
||||
**Description** : Crée une transaction Bitcoin pour ancrer un hash de document.
|
||||
|
||||
**Headers requis** :
|
||||
```
|
||||
x-api-key: your-secure-api-key
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
||||
**Body** :
|
||||
```json
|
||||
{
|
||||
"documentUid": "doc-12345",
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"callback_url": "http://local.4nkweb.com:3001/api/v1/anchors/callback"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 200 OK** :
|
||||
```json
|
||||
{
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"status": "pending",
|
||||
"confirmations": 0,
|
||||
"block_height": null,
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"documentUid": "doc-12345",
|
||||
"context": {
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer": "mempool2.4nkweb.com",
|
||||
"api_version": "1.0.0",
|
||||
"request_timestamp": "2025-11-14T10:30:00.000Z",
|
||||
"document_uid": "doc-12345",
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"status": "pending"
|
||||
},
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 400 Bad Request** (champs manquants) :
|
||||
```json
|
||||
{
|
||||
"error": "Missing required fields: documentUid, hash"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 400 Bad Request** (format hash invalide) :
|
||||
```json
|
||||
{
|
||||
"error": "Invalid hash format (must be 64 hex characters)"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 500 Internal Server Error** :
|
||||
```json
|
||||
{
|
||||
"error": "Internal server error",
|
||||
"message": "Insufficient funds for anchoring transaction"
|
||||
}
|
||||
```
|
||||
|
||||
**Champs** :
|
||||
- `transaction_id` : `string` - **TXID Bitcoin (64 hex)** - Identifiant de transaction consultable sur mempool
|
||||
- `status` : `"pending" | "confirmed"` - État de la transaction
|
||||
- `confirmations` : `number` - Nombre de confirmations (0 si pending)
|
||||
- `block_height` : `number | null` - Hauteur du bloc (null si non confirmé)
|
||||
- `txid` : `string` - TXID Bitcoin (identique à `transaction_id`)
|
||||
- `hash` : `string` - Hash du document ancré (64 hex)
|
||||
- `documentUid` : `string` - Identifiant du document
|
||||
- `explorer_url` : `string | null` - URL de la transaction sur mempool
|
||||
- `context` : `object` - Informations contextuelles
|
||||
|
||||
**Note importante** : Le `transaction_id` est maintenant directement le `txid` Bitcoin, plus d'UUID.
|
||||
|
||||
---
|
||||
|
||||
### 3. GET `/api/anchor/status/:transactionId`
|
||||
|
||||
**Description** : Récupère le statut d'une transaction d'ancrage par son `transaction_id` (txid Bitcoin).
|
||||
|
||||
**Headers requis** :
|
||||
```
|
||||
x-api-key: your-secure-api-key
|
||||
```
|
||||
|
||||
**Réponse 200 OK** :
|
||||
```json
|
||||
{
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"status": "confirmed",
|
||||
"confirmations": 6,
|
||||
"block_height": 141690,
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"documentUid": "doc-12345",
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"network": "signet",
|
||||
"timestamp": "2025-11-14T10:25:00.000Z",
|
||||
"fee": -0.00000234,
|
||||
"size": 250,
|
||||
"anchor_info": {
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"document_uid": "doc-12345",
|
||||
"op_return_data": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"anchored_at": "2025-11-14T10:25:00.000Z",
|
||||
"block_height": 141690,
|
||||
"confirmations": 6,
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"network": "signet"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 400 Bad Request** :
|
||||
```json
|
||||
{
|
||||
"error": "Missing transaction_id"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 404 Not Found** :
|
||||
```json
|
||||
{
|
||||
"error": "Transaction not found"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 500 Internal Server Error** :
|
||||
```json
|
||||
{
|
||||
"error": "Internal server error",
|
||||
"message": "Bitcoin RPC error"
|
||||
}
|
||||
```
|
||||
|
||||
**Champs** :
|
||||
- `transaction_id` : `string` - TXID Bitcoin (64 hex)
|
||||
- `status` : `"pending" | "confirmed"` - État de la transaction
|
||||
- `confirmations` : `number` - Nombre de confirmations
|
||||
- `block_height` : `number | null` - Hauteur du bloc
|
||||
- `txid` : `string` - TXID Bitcoin (identique à `transaction_id`)
|
||||
- `hash` : `string` - Hash du document ancré
|
||||
- `documentUid` : `string` - Identifiant du document
|
||||
- `explorer_url` : `string` - URL mempool
|
||||
- `network` : `string` - Réseau Bitcoin (signet)
|
||||
- `timestamp` : `string | undefined` - ISO 8601 timestamp de la transaction
|
||||
- `fee` : `number | undefined` - Frais de transaction en BTC
|
||||
- `size` : `number | undefined` - Taille de la transaction en bytes
|
||||
- `anchor_info` : `object` - Informations détaillées sur l'ancrage
|
||||
|
||||
---
|
||||
|
||||
### 4. POST `/api/anchor/verify`
|
||||
|
||||
**Description** : Vérifie si un hash est ancré dans la blockchain Bitcoin.
|
||||
|
||||
**Headers requis** :
|
||||
```
|
||||
x-api-key: your-secure-api-key
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
||||
**Body** :
|
||||
```json
|
||||
{
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 200 OK** (hash vérifié) :
|
||||
```json
|
||||
{
|
||||
"verified": true,
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"anchor_info": {
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"block_height": 141690,
|
||||
"confirmations": 6,
|
||||
"timestamp": "2025-11-14T10:25:00.000Z",
|
||||
"fee": -0.00000234,
|
||||
"size": 250,
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"network": "signet",
|
||||
"op_return_data": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"anchored_at": "2025-11-14T10:25:00.000Z"
|
||||
},
|
||||
"context": {
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer": "mempool2.4nkweb.com",
|
||||
"api_version": "1.0.0",
|
||||
"verification_timestamp": "2025-11-14T10:30:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 200 OK** (hash non trouvé) :
|
||||
```json
|
||||
{
|
||||
"verified": false,
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"context": {
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer": "mempool2.4nkweb.com",
|
||||
"api_version": "1.0.0",
|
||||
"verification_timestamp": "2025-11-14T10:30:00.000Z",
|
||||
"message": "Hash not found in blockchain"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 400 Bad Request** :
|
||||
```json
|
||||
{
|
||||
"error": "Missing required field: hash"
|
||||
}
|
||||
```
|
||||
|
||||
**Réponse 400 Bad Request** (format invalide) :
|
||||
```json
|
||||
{
|
||||
"error": "Invalid hash format (must be 64 hex characters)"
|
||||
}
|
||||
```
|
||||
|
||||
**Champs** :
|
||||
- `verified` : `boolean` - Si le hash est ancré dans la blockchain
|
||||
- `hash` : `string` - Hash vérifié
|
||||
- `anchor_info` : `object | undefined` - Présent uniquement si `verified: true`
|
||||
- `transaction_id` : `string` - TXID Bitcoin
|
||||
- `block_height` : `number` - Hauteur du bloc
|
||||
- `confirmations` : `number` - Nombre de confirmations
|
||||
- `timestamp` : `string | undefined` - ISO 8601 timestamp
|
||||
- `fee` : `number | undefined` - Frais en BTC
|
||||
- `size` : `number | undefined` - Taille en bytes
|
||||
- `explorer_url` : `string` - URL mempool
|
||||
- `network` : `string` - Réseau (signet)
|
||||
- `op_return_data` : `string` - Données OP_RETURN
|
||||
- `anchored_at` : `string | undefined` - ISO 8601 timestamp
|
||||
- `context` : `object` - Informations contextuelles
|
||||
- `message` : `string | undefined` - Message explicatif si non vérifié
|
||||
|
||||
---
|
||||
|
||||
## 🔑 Points importants
|
||||
|
||||
### Transaction ID
|
||||
|
||||
- **Avant** : UUID généré (ex: `4b38a41d-f429-4844-b6bd-01dfc5c42625`)
|
||||
- **Maintenant** : TXID Bitcoin direct (ex: `7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825`)
|
||||
- **Format** : 64 caractères hexadécimaux
|
||||
- **Consultable** : Directement sur mempool avec l'URL `https://mempool2.4nkweb.com/fr/tx/{transaction_id}`
|
||||
|
||||
### Statuts
|
||||
|
||||
- `pending` : Transaction créée mais non encore confirmée (0 confirmations)
|
||||
- `confirmed` : Transaction confirmée dans un bloc (≥1 confirmation)
|
||||
|
||||
### Codes HTTP
|
||||
|
||||
- `200` : Succès
|
||||
- `202` : ~~Accepté (plus utilisé, maintenant 200)~~ → **200 OK** (transaction créée immédiatement)
|
||||
- `400` : Erreur de validation (champs manquants, format invalide)
|
||||
- `401` : Non autorisé (API key invalide)
|
||||
- `404` : Transaction non trouvée
|
||||
- `500` : Erreur serveur interne
|
||||
- `503` : Service indisponible (Bitcoin non connecté)
|
||||
|
||||
---
|
||||
|
||||
## 📝 Exemples d'utilisation
|
||||
|
||||
### Créer un ancrage
|
||||
|
||||
```bash
|
||||
curl -X POST http://dev3.4nkweb.com:3002/api/anchor/document \
|
||||
-H "x-api-key: your-secure-api-key" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"documentUid": "doc-12345",
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"callback_url": "http://local.4nkweb.com:3001/api/v1/anchors/callback"
|
||||
}'
|
||||
```
|
||||
|
||||
### Vérifier le statut
|
||||
|
||||
```bash
|
||||
curl -X GET "http://dev3.4nkweb.com:3002/api/anchor/status/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825" \
|
||||
-H "x-api-key: your-secure-api-key"
|
||||
```
|
||||
|
||||
### Vérifier un hash
|
||||
|
||||
```bash
|
||||
curl -X POST http://dev3.4nkweb.com:3002/api/anchor/verify \
|
||||
-H "x-api-key: your-secure-api-key" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"hash": "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825"
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Callbacks
|
||||
|
||||
Si un `callback_url` est fourni lors de l'ancrage, l'API envoie une requête POST avec :
|
||||
|
||||
```json
|
||||
{
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"document_uid": "doc-12345",
|
||||
"status": "pending",
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"confirmations": 0,
|
||||
"block_height": null
|
||||
}
|
||||
```
|
||||
|
||||
Le callback est envoyé en arrière-plan et n'affecte pas la réponse de l'API.
|
||||
@ -1,157 +0,0 @@
|
||||
# Rapport de Vérification Finale - API LeCoffre.io
|
||||
|
||||
## ✅ **TESTS DE VÉRIFICATION COMPLETS**
|
||||
|
||||
### 🎯 **Objectif**
|
||||
Vérifier que l'API fonctionne correctement après la création de l'archive ZIP et que toutes les fonctionnalités sont opérationnelles.
|
||||
|
||||
### 📊 **Résultats des Tests**
|
||||
|
||||
#### 1. **Health Check** ✅
|
||||
```bash
|
||||
GET http://localhost:3002/health
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"service": "anchor-api",
|
||||
"bitcoin": {
|
||||
"connected": true,
|
||||
"blocks": "141690",
|
||||
"network": "signet",
|
||||
"explorer": "mempool2.4nkweb.com"
|
||||
},
|
||||
"context": {
|
||||
"api_version": "1.0.0",
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/",
|
||||
"status": "operational"
|
||||
},
|
||||
"timestamp": "2025-10-27T15:30:54.675Z"
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. **Ancrage de Document** ✅
|
||||
```bash
|
||||
POST http://localhost:3002/api/anchor/document
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
- **Document UID** : `test-final-verification`
|
||||
- **Hash** : `abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890`
|
||||
- **Transaction ID** : `4b38a41d-f429-4844-b6bd-01dfc5c42625`
|
||||
- **Statut** : `pending` → `confirmed`
|
||||
|
||||
#### 3. **Vérification du Statut** ✅
|
||||
```bash
|
||||
GET http://localhost:3002/api/anchor/status/{transaction_id}
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
- **TXID Bitcoin** : `7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825`
|
||||
- **Lien Explorateur** : [https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825](https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825)
|
||||
- **Frais** : -2.34e-06 BTC
|
||||
- **Réseau** : signet
|
||||
|
||||
#### 4. **Vérification d'Ancrage** ✅
|
||||
```bash
|
||||
POST http://localhost:3002/api/anchor/verify
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
- **Vérifié** : `true`
|
||||
- **Hash confirmé** : `abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890`
|
||||
- **Données OP_RETURN** : Confirmées dans la blockchain
|
||||
|
||||
#### 5. **Gestion d'Erreur - Hash Inexistant** ✅
|
||||
```bash
|
||||
POST http://localhost:3002/api/anchor/verify
|
||||
Hash: 0000000000000000000000000000000000000000000000000000000000000000
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
- **Vérifié** : `false`
|
||||
- **Message** : "Hash not found in blockchain"
|
||||
- **Gestion d'erreur** : Correcte
|
||||
|
||||
#### 6. **Authentification API** ✅
|
||||
```bash
|
||||
POST http://localhost:3002/api/anchor/document (sans clé API)
|
||||
```
|
||||
**Résultat** : ✅ **SUCCÈS**
|
||||
- **Erreur** : "Unauthorized: Invalid or missing API key"
|
||||
- **Sécurité** : Fonctionnelle
|
||||
|
||||
### 🔧 **Fonctionnalités Vérifiées**
|
||||
|
||||
#### ✅ **Ancrage Bitcoin**
|
||||
- Création de transactions OP_RETURN
|
||||
- Utilisation du wallet "mining"
|
||||
- Intégration avec Bitcoin Signet
|
||||
- Gestion des frais de transaction
|
||||
|
||||
#### ✅ **Informations Contextuelles**
|
||||
- Liens vers l'explorateur mempool2.4nkweb.com
|
||||
- Métadonnées réseau (Bitcoin Signet)
|
||||
- Timestamps ISO 8601
|
||||
- Version API (1.0.0)
|
||||
|
||||
#### ✅ **Sécurité**
|
||||
- Authentification par clé API
|
||||
- Validation des formats de hash
|
||||
- Gestion des erreurs appropriée
|
||||
- CORS configuré
|
||||
|
||||
#### ✅ **Performance**
|
||||
- Réponses rapides (< 1 seconde)
|
||||
- Gestion des timeouts
|
||||
- Buffer optimisé (10MB)
|
||||
- Parsing JSON intelligent
|
||||
|
||||
### 📈 **Métriques de Performance**
|
||||
|
||||
- **Temps de réponse Health Check** : < 100ms
|
||||
- **Temps d'ancrage** : ~15 secondes (confirmation Bitcoin)
|
||||
- **Temps de vérification** : < 500ms
|
||||
- **Uptime** : 100% pendant les tests
|
||||
|
||||
### 🎯 **État Final**
|
||||
|
||||
#### **API Opérationnelle** ✅
|
||||
- **Connexion Bitcoin** : ✅ Connectée
|
||||
- **Blocs synchronisés** : 141,690
|
||||
- **Wallet** : "mining" (2M+ BTC disponibles)
|
||||
- **Réseau** : Bitcoin Signet
|
||||
|
||||
#### **Fonctionnalités Complètes** ✅
|
||||
- **Ancrage** : ✅ Fonctionnel
|
||||
- **Vérification** : ✅ Fonctionnelle
|
||||
- **Explorateur** : ✅ Intégré
|
||||
- **Sécurité** : ✅ Active
|
||||
|
||||
#### **Archive ZIP** ✅
|
||||
- **Fichier** : `lecoffre-anchor-api.zip` (79 KB)
|
||||
- **Contenu** : Code source + compilé + documentation
|
||||
- **Exclusions** : node_modules, logs, .git
|
||||
|
||||
### 🚀 **Conclusion**
|
||||
|
||||
L'API LeCoffre.io est **entièrement fonctionnelle** et **prête pour la production** :
|
||||
|
||||
1. ✅ **Tous les tests passent**
|
||||
2. ✅ **Ancrage Bitcoin opérationnel**
|
||||
3. ✅ **Sécurité maintenue**
|
||||
4. ✅ **Informations contextuelles enrichies**
|
||||
5. ✅ **Archive ZIP créée avec succès**
|
||||
|
||||
**Aucune modification n'a été apportée** au fonctionnement de l'API lors de la création de l'archive. Toutes les fonctionnalités restent opérationnelles.
|
||||
|
||||
---
|
||||
|
||||
**Date** : 27 octobre 2025
|
||||
**Statut** : ✅ **VÉRIFICATION TERMINÉE - TOUS LES TESTS PASSENT**
|
||||
**Transaction de Test** : `7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825`
|
||||
**Explorateur** : [mempool2.4nkweb.com](https://mempool2.4nkweb.com/fr/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
328
README.md
328
README.md
@ -1,328 +1,2 @@
|
||||
# LeCoffre Anchor API
|
||||
# lecoffre-anchor-api
|
||||
|
||||
API d'ancrage Bitcoin Signet pour LeCoffre.io, déployée sur `dev3.4nkweb.com`.
|
||||
|
||||
## 📦 Vue d'ensemble
|
||||
|
||||
Cette API autonome gère l'ancrage de hashes de documents sur la blockchain Bitcoin Signet. Elle est séparée du backend principal (`lecoffre-back-main`) pour:
|
||||
|
||||
- **Isolation**: Le nœud Bitcoin et l'API d'ancrage tournent sur un serveur dédié (dev3.4nkweb.com)
|
||||
- **Performance**: Évite la surcharge du backend principal avec des opérations blockchain lentes
|
||||
- **Sécurité**: Accès restreint par API key
|
||||
- **Scalabilité**: Peut gérer une file d'attente d'ancrages indépendamment
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
```
|
||||
lecoffre-back-main (local.4nkweb.com:3001)
|
||||
│
|
||||
├─── HTTP POST ───> lecoffre-anchor-api (dev3.4nkweb.com:3002)
|
||||
│ │
|
||||
│ ├─── JSON-RPC ───> Bitcoin Node (localhost:38332)
|
||||
│ └─── Callback ───> lecoffre-back-main
|
||||
│
|
||||
└─── Continue processing...
|
||||
```
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### Prérequis
|
||||
|
||||
- Node.js >= 18
|
||||
- Bitcoin Core node (Signet) configuré avec JSON-RPC
|
||||
- Accès au fichier cookie Bitcoin (`.cookie`)
|
||||
|
||||
### 1. Installer les dépendances
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 2. Configuration
|
||||
|
||||
Copier `.env.example` vers `.env` et configurer:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
nano .env
|
||||
```
|
||||
|
||||
Variables importantes:
|
||||
```env
|
||||
PORT=3002
|
||||
API_KEY=your-secure-api-key-here # Générer avec uuidv4
|
||||
BITCOIN_COOKIE_PATH=/home/bitcoin/.4nk/.cookie
|
||||
CORS_ORIGINS=http://local.4nkweb.com:3001
|
||||
```
|
||||
|
||||
### 3. Build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 4. Démarrer l'API
|
||||
|
||||
```bash
|
||||
# Production
|
||||
npm start
|
||||
|
||||
# Développement (avec auto-reload)
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 📡 Endpoints API
|
||||
|
||||
### Health Check
|
||||
```bash
|
||||
GET /health
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"service": "anchor-api",
|
||||
"bitcoin": {
|
||||
"connected": true,
|
||||
"blocks": 245678
|
||||
},
|
||||
"timestamp": "2025-10-17T14:00:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Ancrer un document
|
||||
```bash
|
||||
POST /api/anchor/document
|
||||
Headers:
|
||||
x-api-key: your-secure-api-key
|
||||
Content-Type: application/json
|
||||
|
||||
Body:
|
||||
{
|
||||
"documentUid": "uuid-of-document",
|
||||
"hash": "64-char-hex-hash",
|
||||
"callback_url": "http://local.4nkweb.com:3001/api/v1/anchors/callback"
|
||||
}
|
||||
```
|
||||
|
||||
**Response** (200 OK):
|
||||
```json
|
||||
{
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"status": "pending",
|
||||
"confirmations": 0,
|
||||
"block_height": null,
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"hash": "64-char-hex-hash",
|
||||
"documentUid": "uuid-of-document",
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"context": {
|
||||
"network": "Bitcoin Signet",
|
||||
"explorer": "mempool2.4nkweb.com",
|
||||
"api_version": "1.0.0",
|
||||
"request_timestamp": "2025-11-14T10:30:00.000Z",
|
||||
"document_uid": "uuid-of-document",
|
||||
"hash": "64-char-hex-hash",
|
||||
"status": "pending"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note** : Le `transaction_id` est maintenant directement le `txid` Bitcoin (64 hex), consultable sur mempool.
|
||||
|
||||
---
|
||||
|
||||
### Vérifier le statut d'un ancrage
|
||||
```bash
|
||||
GET /api/anchor/status/:transactionId
|
||||
Headers:
|
||||
x-api-key: your-secure-api-key
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"transaction_id": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"status": "confirmed",
|
||||
"confirmations": 6,
|
||||
"block_height": 245680,
|
||||
"txid": "7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"hash": "64-char-hex-hash",
|
||||
"documentUid": "uuid-of-document",
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"network": "signet",
|
||||
"timestamp": "2025-11-14T10:25:00.000Z",
|
||||
"fee": -0.00000234,
|
||||
"size": 250,
|
||||
"anchor_info": {
|
||||
"hash": "64-char-hex-hash",
|
||||
"document_uid": "uuid-of-document",
|
||||
"op_return_data": "64-char-hex-hash",
|
||||
"anchored_at": "2025-11-14T10:25:00.000Z",
|
||||
"block_height": 245680,
|
||||
"confirmations": 6,
|
||||
"explorer_url": "https://mempool2.4nkweb.com/fr/tx/7b6f473879b3993812bc5eda39d801c1fd3f918cd35c9f6d922f1c3e95db9825",
|
||||
"network": "signet"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note** : Le `transaction_id` est le `txid` Bitcoin, directement consultable sur mempool.
|
||||
|
||||
---
|
||||
|
||||
### Vérifier si un hash est ancré
|
||||
```bash
|
||||
POST /api/anchor/verify
|
||||
Headers:
|
||||
x-api-key: your-secure-api-key
|
||||
Content-Type: application/json
|
||||
|
||||
Body:
|
||||
{
|
||||
"hash": "64-char-hex-hash",
|
||||
"txid": "bitcoin-transaction-id" # optionnel
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"verified": true,
|
||||
"anchor_info": {
|
||||
"transaction_id": "txid",
|
||||
"block_height": 245680,
|
||||
"confirmations": 6,
|
||||
"timestamp": "2025-10-17T14:00:00.000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🔧 Intégration avec lecoffre-back-main
|
||||
|
||||
### 1. Configuration backend
|
||||
|
||||
Dans `lecoffre-back-main/.env`:
|
||||
```env
|
||||
ANCHOR_API_URL=http://dev3.4nkweb.com:3002
|
||||
ANCHOR_API_KEY=your-secure-api-key
|
||||
```
|
||||
|
||||
### 2. Modifier BitcoinSignetService
|
||||
|
||||
Au lieu d'appeler directement le nœud Bitcoin, faire des appels HTTP vers l'API d'ancrage:
|
||||
|
||||
```typescript
|
||||
// Ancien (direct Bitcoin RPC)
|
||||
const txid = await this.rpcCall('sendrawtransaction', [signedTx.hex]);
|
||||
|
||||
// Nouveau (via Anchor API)
|
||||
const response = await fetch(`${ANCHOR_API_URL}/api/anchor/document`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'x-api-key': ANCHOR_API_KEY,
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
documentUid: document.uid,
|
||||
hash: documentHash,
|
||||
callback_url: `${LECOFFRE_BACK_URL}/api/v1/anchors/callback`
|
||||
})
|
||||
});
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
- **API Key**: Toutes les routes `/api/*` nécessitent un header `x-api-key`
|
||||
- **CORS**: Restreint aux origines configurées
|
||||
- **Rate Limiting**: 100 requêtes/minute par défaut
|
||||
- **Helmet**: Headers de sécurité HTTP
|
||||
|
||||
## 📊 Logs
|
||||
|
||||
Logs écrits dans `./logs/anchor-api.log` (configurable via `LOG_FILE_PATH`).
|
||||
|
||||
Niveaux de log:
|
||||
- `error`: Erreurs critiques
|
||||
- `warn`: Avertissements
|
||||
- `info`: Informations générales
|
||||
- `debug`: Détails de debug
|
||||
|
||||
## 🛠️ Déploiement
|
||||
|
||||
### PM2 (production)
|
||||
|
||||
```bash
|
||||
pm2 start dist/index.js --name lecoffre-anchor-api
|
||||
pm2 save
|
||||
```
|
||||
|
||||
### Docker (optionnel)
|
||||
|
||||
```dockerfile
|
||||
FROM node:18-alpine
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm ci --only=production
|
||||
COPY dist ./dist
|
||||
EXPOSE 3002
|
||||
CMD ["node", "dist/index.js"]
|
||||
```
|
||||
|
||||
## 📝 Maintenance
|
||||
|
||||
### Architecture simplifiée
|
||||
|
||||
L'API ne gère plus de queue en mémoire. Les transactions Bitcoin sont créées immédiatement et le `transaction_id` retourné est directement le `txid` Bitcoin, consultable sur mempool.
|
||||
|
||||
### Monitoring
|
||||
|
||||
- Health check: `curl http://dev3.4nkweb.com:3002/health`
|
||||
- PM2 logs: `pm2 logs lecoffre-anchor-api`
|
||||
- Logs fichier: `tail -f logs/anchor-api.log`
|
||||
|
||||
## 🚨 Troubleshooting
|
||||
|
||||
### Erreur "Bitcoin cookie file not accessible"
|
||||
|
||||
```bash
|
||||
# Vérifier les permissions
|
||||
ls -l /home/bitcoin/.4nk/.cookie
|
||||
|
||||
# Donner accès au user de l'API
|
||||
sudo chmod 644 /home/bitcoin/.4nk/.cookie
|
||||
# OU ajouter le user au groupe bitcoin
|
||||
sudo usermod -a -G bitcoin debian
|
||||
```
|
||||
|
||||
### Erreur "No unspent outputs available"
|
||||
|
||||
Le wallet Bitcoin n'a pas de fonds. Envoyer des tBTC Signet au wallet:
|
||||
|
||||
```bash
|
||||
bitcoin-cli -signet getnewaddress
|
||||
# Utiliser un faucet Signet pour obtenir des tBTC
|
||||
```
|
||||
|
||||
### Callback échoue
|
||||
|
||||
Vérifier que `lecoffre-back-main` est accessible depuis `dev3.4nkweb.com`:
|
||||
|
||||
```bash
|
||||
curl -I http://local.4nkweb.com:3001/api/v1/public/health
|
||||
```
|
||||
|
||||
## 📚 Documentation supplémentaire
|
||||
|
||||
- Bitcoin Signet: https://en.bitcoin.it/wiki/Signet
|
||||
- Bitcoin RPC API: https://developer.bitcoin.org/reference/rpc/
|
||||
- OP_RETURN: https://en.bitcoin.it/wiki/OP_RETURN
|
||||
|
||||
## 📞 Support
|
||||
|
||||
Pour toute question ou problème, consulter:
|
||||
- `/todo/TODO6_IMPLEMENTATION_COMPLETE.md` (backend principal)
|
||||
- Logs: `pm2 logs lecoffre-anchor-api`
|
||||
|
||||
26
env.example
26
env.example
@ -1,26 +0,0 @@
|
||||
# Port de l'API d'ancrage
|
||||
PORT=3002
|
||||
|
||||
# Node.js environment
|
||||
NODE_ENV=production
|
||||
|
||||
# Bitcoin Signet Node (dev3.4nkweb.com)
|
||||
BITCOIN_RPC_HOST=localhost
|
||||
BITCOIN_RPC_PORT=38332
|
||||
BITCOIN_RPC_USER=4nk
|
||||
BITCOIN_RPC_PASSWORD=your_bitcoin_password_here
|
||||
BITCOIN_COOKIE_PATH=/home/bitcoin/.4nk/.cookie
|
||||
|
||||
# API Key pour authentification (générer avec uuidv4)
|
||||
API_KEY=your-secure-api-key-here
|
||||
|
||||
# CORS - Autorisé depuis lecoffre-back-main
|
||||
CORS_ORIGINS=http://localhost:3001,http://local.4nkweb.com:3001,https://local.4nkweb.com
|
||||
|
||||
# Rate Limiting
|
||||
RATE_LIMIT_WINDOW_MS=60000
|
||||
RATE_LIMIT_MAX_REQUESTS=100
|
||||
|
||||
# Logs
|
||||
LOG_LEVEL=info
|
||||
LOG_FILE_PATH=./logs/anchor-api.log
|
||||
3746
package-lock.json
generated
3746
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@ -1,47 +0,0 @@
|
||||
{
|
||||
"name": "lecoffre-anchor-api",
|
||||
"version": "1.0.0",
|
||||
"description": "API d'ancrage Bitcoin Signet pour LeCoffre.io - déployée sur dev3.4nkweb.com",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"start": "node dist/index.js",
|
||||
"dev": "ts-node-dev --respawn --transpile-only src/index.ts",
|
||||
"build": "tsc",
|
||||
"lint": "eslint src --ext .ts",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"keywords": [
|
||||
"bitcoin",
|
||||
"anchoring",
|
||||
"blockchain",
|
||||
"signet",
|
||||
"lecoffre"
|
||||
],
|
||||
"author": "4nk",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"express": "^4.18.2",
|
||||
"cors": "^2.8.5",
|
||||
"helmet": "^7.1.0",
|
||||
"express-rate-limit": "^7.1.5",
|
||||
"axios": "^1.6.5",
|
||||
"winston": "^3.11.0",
|
||||
"dotenv": "^16.3.1",
|
||||
"uuid": "^9.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/express": "^4.17.21",
|
||||
"@types/cors": "^2.8.17",
|
||||
"@types/node": "^20.10.6",
|
||||
"@types/uuid": "^9.0.7",
|
||||
"typescript": "^5.3.3",
|
||||
"ts-node-dev": "^2.0.0",
|
||||
"eslint": "^8.56.0",
|
||||
"@typescript-eslint/eslint-plugin": "^6.17.0",
|
||||
"@typescript-eslint/parser": "^6.17.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
import { IBitcoinRPCConfig } from '../types';
|
||||
|
||||
export const getBitcoinConfig = (): IBitcoinRPCConfig => {
|
||||
return {
|
||||
host: process.env['BITCOIN_RPC_HOST'] || 'localhost',
|
||||
port: parseInt(process.env['BITCOIN_RPC_PORT'] || '38332', 10),
|
||||
username: process.env['BITCOIN_RPC_USER'] || '4nk',
|
||||
password: process.env['BITCOIN_RPC_PASSWORD'],
|
||||
cookiePath: process.env['BITCOIN_COOKIE_PATH'] || '/home/ank/.bitcoin/signet/.cookie',
|
||||
};
|
||||
};
|
||||
@ -1,33 +0,0 @@
|
||||
import winston from 'winston';
|
||||
|
||||
const LOG_LEVEL = process.env['LOG_LEVEL'] || 'info';
|
||||
const LOG_FILE_PATH = process.env['LOG_FILE_PATH'] || './logs/anchor-api.log';
|
||||
|
||||
const logger = winston.createLogger({
|
||||
level: LOG_LEVEL,
|
||||
format: winston.format.combine(
|
||||
winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
|
||||
winston.format.errors({ stack: true }),
|
||||
winston.format.splat(),
|
||||
winston.format.json()
|
||||
),
|
||||
defaultMeta: { service: 'anchor-api' },
|
||||
transports: [
|
||||
// Console transport
|
||||
new winston.transports.Console({
|
||||
format: winston.format.combine(
|
||||
winston.format.colorize(),
|
||||
winston.format.printf(
|
||||
(info) => `${info.timestamp} ${info.level}: ${info.message}`
|
||||
)
|
||||
),
|
||||
}),
|
||||
// File transport
|
||||
new winston.transports.File({
|
||||
filename: LOG_FILE_PATH,
|
||||
format: winston.format.json(),
|
||||
}),
|
||||
],
|
||||
});
|
||||
|
||||
export default logger;
|
||||
@ -1,244 +0,0 @@
|
||||
import { Request, Response } from 'express';
|
||||
import { AnchorQueueService } from '../services/AnchorQueueService';
|
||||
import { BitcoinService } from '../services/BitcoinService';
|
||||
import logger from '../config/logger';
|
||||
import { IAnchorRequest, IVerifyRequest } from '../types';
|
||||
|
||||
export class AnchorController {
|
||||
private anchorQueue: AnchorQueueService;
|
||||
private bitcoinService: BitcoinService;
|
||||
|
||||
constructor(anchorQueue: AnchorQueueService, bitcoinService: BitcoinService) {
|
||||
this.anchorQueue = anchorQueue;
|
||||
this.bitcoinService = bitcoinService;
|
||||
}
|
||||
|
||||
/**
|
||||
* POST /api/anchor/document
|
||||
* Ancre un document sur Bitcoin Signet
|
||||
*/
|
||||
public async anchorDocument(req: Request, res: Response): Promise<void> {
|
||||
try {
|
||||
const { documentUid, hash, callback_url }: IAnchorRequest = req.body;
|
||||
|
||||
// Validation
|
||||
if (!documentUid || !hash) {
|
||||
res.status(400).json({
|
||||
error: 'Missing required fields: documentUid, hash',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
if (!/^[a-f0-9]{64}$/i.test(hash)) {
|
||||
res.status(400).json({
|
||||
error: 'Invalid hash format (must be 64 hex characters)',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
logger.info(`📥 Anchor request: document=${documentUid}, hash=${hash.substring(0, 16)}...`);
|
||||
|
||||
// Créer la transaction Bitcoin directement
|
||||
const response = await this.anchorQueue.enqueue({
|
||||
documentUid,
|
||||
hash,
|
||||
callback_url,
|
||||
});
|
||||
|
||||
// Enrichir la réponse avec des informations contextuelles
|
||||
const enrichedResponse = {
|
||||
...response,
|
||||
context: {
|
||||
network: 'Bitcoin Signet',
|
||||
explorer: 'mempool2.4nkweb.com',
|
||||
api_version: '1.0.0',
|
||||
request_timestamp: new Date().toISOString(),
|
||||
document_uid: documentUid,
|
||||
hash: hash,
|
||||
status: response.status
|
||||
},
|
||||
explorer_url: response.txid ? `https://mempool2.4nkweb.com/fr/tx/${response.txid}` : null
|
||||
};
|
||||
|
||||
res.status(200).json(enrichedResponse);
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Anchor error: ${error.message}`);
|
||||
res.status(500).json({
|
||||
error: 'Internal server error',
|
||||
message: error.message,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /api/anchor/status/:transactionId
|
||||
* Récupère le statut d'un ancrage
|
||||
*/
|
||||
public async getStatus(req: Request, res: Response): Promise<void> {
|
||||
try {
|
||||
const { transactionId } = req.params;
|
||||
|
||||
if (!transactionId) {
|
||||
res.status(400).json({
|
||||
error: 'Missing transaction_id',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const status = await this.anchorQueue.getStatus(transactionId);
|
||||
|
||||
if (!status) {
|
||||
res.status(404).json({
|
||||
error: 'Transaction not found',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// Récupérer les infos à jour depuis Bitcoin
|
||||
try {
|
||||
const txStatus = await this.bitcoinService.getTransactionStatus(transactionId);
|
||||
status.confirmations = txStatus.confirmations;
|
||||
status.block_height = txStatus.block_height;
|
||||
status.status = txStatus.confirmations > 0 ? 'confirmed' : 'pending';
|
||||
|
||||
// Enrichir avec des informations contextuelles
|
||||
status.explorer_url = `https://mempool2.4nkweb.com/fr/tx/${transactionId}`;
|
||||
status.network = 'signet';
|
||||
status.timestamp = txStatus.timestamp ? new Date(txStatus.timestamp * 1000).toISOString() : undefined;
|
||||
status.fee = txStatus.fee;
|
||||
status.size = txStatus.size;
|
||||
|
||||
// Informations sur l'ancrage
|
||||
status.anchor_info = {
|
||||
hash: status.hash || '',
|
||||
document_uid: status.documentUid || '',
|
||||
op_return_data: status.hash || '',
|
||||
anchored_at: status.timestamp,
|
||||
block_height: status.block_height,
|
||||
confirmations: status.confirmations,
|
||||
explorer_url: status.explorer_url,
|
||||
network: status.network
|
||||
};
|
||||
} catch (err: any) {
|
||||
logger.warn(`⚠️ Failed to get tx status: ${err.message}`);
|
||||
}
|
||||
|
||||
res.status(200).json(status);
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Status check error: ${error.message}`);
|
||||
res.status(500).json({
|
||||
error: 'Internal server error',
|
||||
message: error.message,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* POST /api/anchor/verify
|
||||
* Vérifie si un hash est ancré
|
||||
*/
|
||||
public async verify(req: Request, res: Response): Promise<void> {
|
||||
try {
|
||||
const { hash, txid }: IVerifyRequest & { txid?: string } = req.body;
|
||||
|
||||
if (!hash) {
|
||||
res.status(400).json({
|
||||
error: 'Missing required field: hash',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
if (!/^[a-f0-9]{64}$/i.test(hash)) {
|
||||
res.status(400).json({
|
||||
error: 'Invalid hash format (must be 64 hex characters)',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
logger.info(`🔍 Verify request: hash=${hash.substring(0, 16)}...`);
|
||||
|
||||
const verified = await this.bitcoinService.verifyAnchor(hash, txid);
|
||||
|
||||
if (verified && txid) {
|
||||
const txStatus = await this.bitcoinService.getTransactionStatus(txid);
|
||||
res.status(200).json({
|
||||
verified: true,
|
||||
hash: hash,
|
||||
anchor_info: {
|
||||
transaction_id: txid,
|
||||
block_height: txStatus.block_height,
|
||||
confirmations: txStatus.confirmations,
|
||||
timestamp: txStatus.timestamp ? new Date(txStatus.timestamp * 1000).toISOString() : undefined,
|
||||
fee: txStatus.fee,
|
||||
size: txStatus.size,
|
||||
explorer_url: `https://mempool2.4nkweb.com/fr/tx/${txid}`,
|
||||
network: 'signet',
|
||||
op_return_data: hash,
|
||||
anchored_at: txStatus.timestamp ? new Date(txStatus.timestamp * 1000).toISOString() : undefined,
|
||||
},
|
||||
context: {
|
||||
network: 'Bitcoin Signet',
|
||||
explorer: 'mempool2.4nkweb.com',
|
||||
api_version: '1.0.0',
|
||||
verification_timestamp: new Date().toISOString()
|
||||
}
|
||||
});
|
||||
} else {
|
||||
res.status(200).json({
|
||||
verified: false,
|
||||
hash: hash,
|
||||
context: {
|
||||
network: 'Bitcoin Signet',
|
||||
explorer: 'mempool2.4nkweb.com',
|
||||
api_version: '1.0.0',
|
||||
verification_timestamp: new Date().toISOString(),
|
||||
message: 'Hash not found in blockchain'
|
||||
}
|
||||
});
|
||||
}
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Verify error: ${error.message}`);
|
||||
res.status(500).json({
|
||||
error: 'Internal server error',
|
||||
message: error.message,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /health
|
||||
* Health check
|
||||
*/
|
||||
public async health(_req: Request, res: Response): Promise<void> {
|
||||
try {
|
||||
const bitcoinConnected = await this.bitcoinService.testConnection();
|
||||
const blockCount = await this.bitcoinService.getBlockCount();
|
||||
|
||||
res.status(200).json({
|
||||
ok: true,
|
||||
service: 'anchor-api',
|
||||
bitcoin: {
|
||||
connected: bitcoinConnected,
|
||||
blocks: blockCount,
|
||||
network: 'signet',
|
||||
explorer: 'mempool2.4nkweb.com'
|
||||
},
|
||||
context: {
|
||||
api_version: '1.0.0',
|
||||
network: 'Bitcoin Signet',
|
||||
explorer_url: 'https://mempool2.4nkweb.com/fr/',
|
||||
status: bitcoinConnected ? 'operational' : 'degraded'
|
||||
},
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Health check failed: ${error.message}`);
|
||||
res.status(503).json({
|
||||
ok: false,
|
||||
service: 'anchor-api',
|
||||
error: error.message,
|
||||
timestamp: new Date().toISOString(),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
116
src/index.ts
116
src/index.ts
@ -1,116 +0,0 @@
|
||||
import 'dotenv/config';
|
||||
import express, { Request, Response, NextFunction } from 'express';
|
||||
import cors, { CorsOptions } from 'cors';
|
||||
import helmet from 'helmet';
|
||||
import rateLimit from 'express-rate-limit';
|
||||
import logger from './config/logger';
|
||||
import { getBitcoinConfig } from './config/bitcoin.config';
|
||||
import { BitcoinService } from './services/BitcoinService';
|
||||
import { AnchorQueueService } from './services/AnchorQueueService';
|
||||
import { AnchorController } from './controllers/AnchorController';
|
||||
|
||||
const PORT = parseInt(process.env['PORT'] || '3002', 10);
|
||||
const API_KEY = process.env['API_KEY'];
|
||||
const CORS_ORIGINS = (process.env['CORS_ORIGINS'] || 'http://localhost:3001')
|
||||
.split(',')
|
||||
.map((origin) => origin.trim())
|
||||
.filter(Boolean);
|
||||
const ALLOWED_ORIGINS = new Set(CORS_ORIGINS);
|
||||
|
||||
// Initialize Express
|
||||
const app = express();
|
||||
|
||||
// Security middleware
|
||||
app.use(helmet());
|
||||
const corsOptions: CorsOptions = {
|
||||
origin: (origin, callback) => {
|
||||
if (!origin || ALLOWED_ORIGINS.has(origin)) {
|
||||
return callback(null, true);
|
||||
}
|
||||
|
||||
return callback(new Error(`CORS origin not allowed: ${origin}`));
|
||||
},
|
||||
credentials: true,
|
||||
};
|
||||
|
||||
const corsMiddleware = cors(corsOptions);
|
||||
|
||||
app.use((req, res, next) => {
|
||||
corsMiddleware(req, res, (error) => {
|
||||
if (error) {
|
||||
const origin = req.headers['origin'] || 'unknown';
|
||||
logger.warn(`🛑 CORS denied for origin ${origin}`);
|
||||
res.status(403).json({
|
||||
error: 'CORS origin forbidden',
|
||||
origin,
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
next();
|
||||
});
|
||||
});
|
||||
app.use(express.json());
|
||||
|
||||
// Rate limiting
|
||||
const limiter = rateLimit({
|
||||
windowMs: parseInt(process.env['RATE_LIMIT_WINDOW_MS'] || '60000', 10),
|
||||
max: parseInt(process.env['RATE_LIMIT_MAX_REQUESTS'] || '100', 10),
|
||||
message: 'Too many requests, please try again later',
|
||||
});
|
||||
app.use('/api/', limiter);
|
||||
|
||||
// API Key middleware
|
||||
const apiKeyMiddleware = (req: Request, res: Response, next: NextFunction) => {
|
||||
const providedKey = req.headers['x-api-key'];
|
||||
|
||||
if (!API_KEY) {
|
||||
logger.warn('⚠️ API_KEY not configured, authentication disabled');
|
||||
return next();
|
||||
}
|
||||
|
||||
if (!providedKey || providedKey !== API_KEY) {
|
||||
logger.warn(`🚫 Unauthorized access attempt from ${req.ip}`);
|
||||
return res.status(401).json({ error: 'Unauthorized: Invalid or missing API key' });
|
||||
}
|
||||
|
||||
next();
|
||||
};
|
||||
|
||||
// Initialize services
|
||||
const bitcoinConfig = getBitcoinConfig();
|
||||
const bitcoinService = new BitcoinService(bitcoinConfig);
|
||||
const anchorQueue = new AnchorQueueService(bitcoinService);
|
||||
const anchorController = new AnchorController(anchorQueue, bitcoinService);
|
||||
|
||||
// Routes
|
||||
app.get('/health', (req, res) => anchorController.health(req, res));
|
||||
app.post('/api/anchor/document', apiKeyMiddleware, (req, res) => anchorController.anchorDocument(req, res));
|
||||
app.get('/api/anchor/status/:transactionId', apiKeyMiddleware, (req, res) => anchorController.getStatus(req, res));
|
||||
app.post('/api/anchor/verify', apiKeyMiddleware, (req, res) => anchorController.verify(req, res));
|
||||
|
||||
// Error handling middleware
|
||||
app.use((err: Error, _req: Request, res: Response, _next: NextFunction) => {
|
||||
logger.error(`❌ Unhandled error: ${err.message}`);
|
||||
res.status(500).json({
|
||||
error: 'Internal server error',
|
||||
message: err.message,
|
||||
});
|
||||
});
|
||||
|
||||
// Start server
|
||||
app.listen(PORT, async () => {
|
||||
logger.info(`🚀 Anchor API started on port ${PORT}`);
|
||||
logger.info(`📡 Bitcoin RPC: ${bitcoinConfig.host}:${bitcoinConfig.port}`);
|
||||
logger.info(`🔐 CORS Origins: ${CORS_ORIGINS.join(', ')}`);
|
||||
logger.info(`🔑 API Key authentication: ${API_KEY ? 'enabled' : 'disabled'}`);
|
||||
|
||||
// Test Bitcoin connection
|
||||
try {
|
||||
await bitcoinService.testConnection();
|
||||
logger.info('✅ Anchor API ready');
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Bitcoin connection failed: ${error.message}`);
|
||||
logger.warn('⚠️ API started but Bitcoin anchoring is disabled');
|
||||
}
|
||||
});
|
||||
@ -1,109 +0,0 @@
|
||||
import logger from '../config/logger';
|
||||
import { BitcoinService } from './BitcoinService';
|
||||
import { IAnchorRequest, IAnchorResponse } from '../types';
|
||||
|
||||
/**
|
||||
* Service d'ancrage Bitcoin
|
||||
* Crée directement les transactions Bitcoin sans queue
|
||||
*/
|
||||
export class AnchorQueueService {
|
||||
private bitcoinService: BitcoinService;
|
||||
|
||||
constructor(bitcoinService: BitcoinService) {
|
||||
this.bitcoinService = bitcoinService;
|
||||
}
|
||||
|
||||
/**
|
||||
* Crée une transaction d'ancrage et retourne le txid comme transaction_id
|
||||
*/
|
||||
public async enqueue(request: IAnchorRequest): Promise<IAnchorResponse> {
|
||||
try {
|
||||
logger.info(`📝 Creating anchor transaction for document ${request.documentUid}`);
|
||||
|
||||
// Créer la transaction Bitcoin immédiatement
|
||||
const txid = await this.bitcoinService.anchorHash(request.hash);
|
||||
|
||||
// Récupérer le statut initial de la transaction
|
||||
const txStatus = await this.bitcoinService.getTransactionStatus(txid);
|
||||
|
||||
logger.info(`✅ Anchor transaction created: txid=${txid}, confirmations=${txStatus.confirmations}`);
|
||||
|
||||
// Appeler le callback si configuré (en arrière-plan)
|
||||
if (request.callback_url) {
|
||||
this.triggerCallback(txid, request.documentUid, request.callback_url, txStatus).catch((err) => {
|
||||
logger.error(`❌ Callback failed for ${txid}: ${err.message}`);
|
||||
});
|
||||
}
|
||||
|
||||
return {
|
||||
transaction_id: txid,
|
||||
status: txStatus.confirmations > 0 ? 'confirmed' : 'pending',
|
||||
confirmations: txStatus.confirmations,
|
||||
block_height: txStatus.block_height,
|
||||
txid: txid,
|
||||
hash: request.hash,
|
||||
documentUid: request.documentUid,
|
||||
};
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Anchor transaction creation failed: ${error.message}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Récupère le statut d'une transaction directement depuis Bitcoin
|
||||
*/
|
||||
public async getStatus(transactionId: string): Promise<IAnchorResponse | null> {
|
||||
try {
|
||||
const txStatus = await this.bitcoinService.getTransactionStatus(transactionId);
|
||||
|
||||
return {
|
||||
transaction_id: transactionId,
|
||||
status: txStatus.confirmations > 0 ? 'confirmed' : 'pending',
|
||||
confirmations: txStatus.confirmations,
|
||||
block_height: txStatus.block_height,
|
||||
txid: transactionId,
|
||||
};
|
||||
} catch (error: any) {
|
||||
logger.warn(`⚠️ Transaction ${transactionId} not found: ${error.message}`);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appelle l'URL de callback avec le résultat de l'ancrage
|
||||
*/
|
||||
private async triggerCallback(
|
||||
txid: string,
|
||||
documentUid: string,
|
||||
callbackUrl: string,
|
||||
txStatus: { confirmations: number; block_height?: number }
|
||||
): Promise<void> {
|
||||
try {
|
||||
logger.info(`📞 Calling callback for transaction ${txid}: ${callbackUrl}`);
|
||||
|
||||
const response = await fetch(callbackUrl, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: JSON.stringify({
|
||||
transaction_id: txid,
|
||||
document_uid: documentUid,
|
||||
status: txStatus.confirmations > 0 ? 'confirmed' : 'pending',
|
||||
txid: txid,
|
||||
confirmations: txStatus.confirmations,
|
||||
block_height: txStatus.block_height,
|
||||
}),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
logger.warn(`⚠️ Callback failed for transaction ${txid}: ${response.status} ${response.statusText}`);
|
||||
} else {
|
||||
logger.info(`✅ Callback successful for transaction ${txid}`);
|
||||
}
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Callback error for transaction ${txid}: ${error.message}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,195 +0,0 @@
|
||||
import logger from '../config/logger';
|
||||
import { IBitcoinRPCConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Service pour interagir avec le nœud Bitcoin Signet
|
||||
*/
|
||||
export class BitcoinService {
|
||||
constructor(_config: IBitcoinRPCConfig) {
|
||||
// Configuration Bitcoin (utilisée pour les logs)
|
||||
}
|
||||
|
||||
/**
|
||||
* Effectue un appel RPC au nœud Bitcoin avec timeout
|
||||
*/
|
||||
private async rpcCall(method: string, params: any[] = [], wallet?: string): Promise<any> {
|
||||
const { exec } = require('child_process');
|
||||
const { promisify } = require('util');
|
||||
const execAsync = promisify(exec);
|
||||
|
||||
try {
|
||||
const walletParam = wallet ? `-rpcwallet=${wallet}` : '';
|
||||
const paramsStr = params.map(p => {
|
||||
if (typeof p === 'string') {
|
||||
return p === '' ? '""' : `"${p}"`;
|
||||
}
|
||||
// Pour les objets, utiliser JSON.stringify avec échappement des guillemets
|
||||
return `'${JSON.stringify(p).replace(/'/g, "'\"'\"'")}'`;
|
||||
}).join(' ');
|
||||
const command = `bitcoin-cli -signet ${walletParam} ${method} ${paramsStr}`;
|
||||
|
||||
logger.info(`Executing Bitcoin CLI: ${command}`);
|
||||
|
||||
const { stdout, stderr } = await execAsync(command, {
|
||||
timeout: 30000,
|
||||
maxBuffer: 1024 * 1024 * 10 // 10MB buffer
|
||||
});
|
||||
|
||||
if (stderr) {
|
||||
logger.error(`Bitcoin CLI stderr: ${stderr}`);
|
||||
}
|
||||
|
||||
// Bitcoin CLI retourne parfois du JSON, parfois du texte brut
|
||||
const trimmedOutput = stdout.trim();
|
||||
|
||||
// Si la sortie commence par { ou [, c'est probablement du JSON
|
||||
if (trimmedOutput.startsWith('{') || trimmedOutput.startsWith('[')) {
|
||||
try {
|
||||
return JSON.parse(trimmedOutput);
|
||||
} catch (parseError) {
|
||||
logger.warn(`Failed to parse JSON, returning as text: ${trimmedOutput}`);
|
||||
return trimmedOutput;
|
||||
}
|
||||
} else {
|
||||
// Sinon, c'est du texte brut
|
||||
logger.debug(`Bitcoin CLI returned text: ${trimmedOutput}`);
|
||||
return trimmedOutput;
|
||||
}
|
||||
} catch (error: any) {
|
||||
logger.error(`Bitcoin CLI Error: ${error.message}`);
|
||||
throw new Error(`Bitcoin CLI Error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Teste la connexion au nœud Bitcoin
|
||||
*/
|
||||
public async testConnection(): Promise<boolean> {
|
||||
try {
|
||||
const blockchainInfo = await this.rpcCall('getblockchaininfo');
|
||||
logger.info(`✅ Bitcoin Signet connected: ${blockchainInfo.chain}, blocks: ${blockchainInfo.blocks}`);
|
||||
return true;
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Bitcoin connection failed: ${error.message}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Crée une transaction OP_RETURN pour ancrer un hash
|
||||
*/
|
||||
public async anchorHash(hash: string): Promise<string> {
|
||||
try {
|
||||
// 1. Vérifier le solde du wallet
|
||||
const balance = await this.rpcCall('getbalance', [], 'mining');
|
||||
logger.info(`Wallet balance: ${balance} BTC`);
|
||||
|
||||
if (parseFloat(balance) < 0.0001) {
|
||||
throw new Error('Insufficient funds for anchoring transaction');
|
||||
}
|
||||
|
||||
// 2. Préparer le script OP_RETURN
|
||||
const opReturnData = hash; // Le hash est déjà en hexadécimal
|
||||
logger.debug(`OP_RETURN data: ${opReturnData}`);
|
||||
|
||||
// 3. Créer une adresse de réception (pour le change)
|
||||
const changeAddress = await this.rpcCall('getnewaddress', ['', 'legacy'], 'mining');
|
||||
|
||||
// 4. Utiliser fundrawtransaction pour créer automatiquement la transaction
|
||||
const rawTx = await this.rpcCall('createrawtransaction', [
|
||||
[],
|
||||
{
|
||||
data: opReturnData,
|
||||
},
|
||||
], 'mining');
|
||||
|
||||
// 5. Financer la transaction automatiquement
|
||||
const fundedTx = await this.rpcCall('fundrawtransaction', [rawTx, { changeAddress }], 'mining');
|
||||
|
||||
// 6. Signer la transaction
|
||||
const signedTx = await this.rpcCall('signrawtransactionwithwallet', [fundedTx.hex], 'mining');
|
||||
|
||||
if (!signedTx.complete) {
|
||||
throw new Error('Transaction signing failed');
|
||||
}
|
||||
|
||||
// 7. Envoyer la transaction
|
||||
const txid = await this.rpcCall('sendrawtransaction', [signedTx.hex], 'mining');
|
||||
|
||||
logger.info(`✅ Anchor transaction sent: ${txid}`);
|
||||
return txid;
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Anchor transaction failed: ${error.message}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Vérifie le statut d'une transaction
|
||||
*/
|
||||
public async getTransactionStatus(txid: string): Promise<{
|
||||
confirmations: number;
|
||||
block_height?: number;
|
||||
timestamp?: number;
|
||||
fee?: number;
|
||||
size?: number;
|
||||
vsize?: number;
|
||||
weight?: number;
|
||||
}> {
|
||||
try {
|
||||
const tx = await this.rpcCall('gettransaction', [txid], 'mining');
|
||||
|
||||
return {
|
||||
confirmations: tx.confirmations || 0,
|
||||
block_height: tx.blockheight,
|
||||
timestamp: tx.blocktime,
|
||||
fee: tx.fee,
|
||||
size: tx.size,
|
||||
vsize: tx.vsize,
|
||||
weight: tx.weight,
|
||||
};
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Transaction status check failed: ${error.message}`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Récupère le nombre actuel de blocs
|
||||
*/
|
||||
public async getBlockCount(): Promise<number> {
|
||||
return await this.rpcCall('getblockcount');
|
||||
}
|
||||
|
||||
/**
|
||||
* Vérifie si un hash est ancré dans une transaction
|
||||
*/
|
||||
public async verifyAnchor(hash: string, txid?: string): Promise<boolean> {
|
||||
try {
|
||||
if (!txid) {
|
||||
// Rechercher dans les transactions récentes
|
||||
logger.warn('⚠️ No txid provided, cannot verify anchor without txid');
|
||||
return false;
|
||||
}
|
||||
|
||||
const tx = await this.rpcCall('getrawtransaction', [txid, true]);
|
||||
|
||||
// Rechercher le hash dans les outputs OP_RETURN
|
||||
for (const vout of tx.vout) {
|
||||
if (vout.scriptPubKey && vout.scriptPubKey.type === 'nulldata') {
|
||||
const opReturnData = vout.scriptPubKey.hex.substring(4); // Enlever le préfixe OP_RETURN (6a)
|
||||
if (opReturnData === hash) {
|
||||
logger.info(`✅ Hash verified in transaction ${txid}`);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
logger.warn(`⚠️ Hash not found in transaction ${txid}`);
|
||||
return false;
|
||||
} catch (error: any) {
|
||||
logger.error(`❌ Anchor verification failed: ${error.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,89 +0,0 @@
|
||||
export interface IAnchorRequest {
|
||||
documentUid: string;
|
||||
hash: string;
|
||||
callback_url?: string;
|
||||
}
|
||||
|
||||
export interface IAnchorResponse {
|
||||
transaction_id: string;
|
||||
status: 'pending' | 'confirmed' | 'failed';
|
||||
confirmations?: number;
|
||||
block_height?: number;
|
||||
txid?: string;
|
||||
hash?: string;
|
||||
documentUid?: string;
|
||||
timestamp?: string;
|
||||
fee?: number;
|
||||
size?: number;
|
||||
vsize?: number;
|
||||
weight?: number;
|
||||
explorer_url?: string;
|
||||
network?: string;
|
||||
anchor_info?: {
|
||||
hash: string;
|
||||
document_uid: string;
|
||||
op_return_data: string;
|
||||
anchored_at?: string;
|
||||
block_height?: number;
|
||||
confirmations?: number;
|
||||
explorer_url?: string;
|
||||
network?: string;
|
||||
};
|
||||
context?: {
|
||||
network: string;
|
||||
explorer: string;
|
||||
api_version: string;
|
||||
request_timestamp?: string;
|
||||
verification_timestamp?: string;
|
||||
document_uid?: string;
|
||||
hash?: string;
|
||||
status?: string;
|
||||
message?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IAnchorStatusResponse extends IAnchorResponse {
|
||||
verified: boolean;
|
||||
}
|
||||
|
||||
export interface IVerifyRequest {
|
||||
hash: string;
|
||||
}
|
||||
|
||||
export interface IVerifyResponse {
|
||||
verified: boolean;
|
||||
hash?: string;
|
||||
anchor_info?: {
|
||||
transaction_id: string;
|
||||
block_height: number;
|
||||
confirmations: number;
|
||||
timestamp: string;
|
||||
fee?: number;
|
||||
size?: number;
|
||||
explorer_url?: string;
|
||||
network?: string;
|
||||
op_return_data?: string;
|
||||
anchored_at?: string;
|
||||
};
|
||||
context?: {
|
||||
network: string;
|
||||
explorer: string;
|
||||
api_version: string;
|
||||
verification_timestamp: string;
|
||||
message?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IBitcoinRPCConfig {
|
||||
host: string;
|
||||
port: number;
|
||||
username: string;
|
||||
password?: string;
|
||||
cookiePath?: string;
|
||||
}
|
||||
|
||||
export interface IBitcoinRPCResponse {
|
||||
result: any;
|
||||
error: any;
|
||||
id: string | number;
|
||||
}
|
||||
@ -1,96 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Minimal positive-flow test for LeCoffre Anchor API
|
||||
# Usage: ./test-api-ok.sh [API_URL] [API_KEY]
|
||||
|
||||
# Load environment variables when .env exists
|
||||
if [ -f ".env" ]; then
|
||||
set -o allexport
|
||||
# shellcheck disable=SC1091
|
||||
source ".env"
|
||||
set +o allexport
|
||||
fi
|
||||
|
||||
API_URL=${1:-"${ANCHORE_API_URL:-}"} # No fallback: must be provided
|
||||
API_KEY=${2:-"${ANCHORE_API_KEY:-}"} # No fallback: must be provided
|
||||
|
||||
if [ -z "$API_URL" ]; then
|
||||
echo "❌ ANCHORE_API_URL non défini (fournir la variable ou passer l'URL en argument)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -z "$API_KEY" ]; then
|
||||
echo "❌ ANCHORE_API_KEY non défini (fournir la variable ou passer la clé en argument)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "🧪 Test OK - Anchor API"
|
||||
echo "📍 URL: $API_URL"
|
||||
echo "🔑 API Key: ${API_KEY:0:8}..."
|
||||
echo ""
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# Health check (expected 200)
|
||||
echo "1. Health check"
|
||||
curl -s -o /tmp/anchor_health.json -w "%{http_code}" "$API_URL/health" > /tmp/anchor_health_code.txt
|
||||
|
||||
health_code=$(cat /tmp/anchor_health_code.txt)
|
||||
if [ "$health_code" != "200" ]; then
|
||||
echo "❌ Health check a retourné HTTP $health_code"
|
||||
cat /tmp/anchor_health.json
|
||||
exit 1
|
||||
fi
|
||||
echo " ✅ Health OK"
|
||||
|
||||
# Positive anchor document (expected 200)
|
||||
echo "2. Anchor document (OK case)"
|
||||
payload='{"documentUid":"ok-test","hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}'
|
||||
response=$(curl -s -w "\n%{http_code}" -X POST "$API_URL/api/anchor/document" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "x-api-key: $API_KEY" \
|
||||
-d "$payload")
|
||||
|
||||
http_code=$(echo "$response" | tail -n1)
|
||||
body=$(echo "$response" | head -n -1)
|
||||
|
||||
if [ "$http_code" != "200" ]; then
|
||||
echo "❌ Anchor document a retourné HTTP $http_code (attendu 200)"
|
||||
echo "$body"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
transaction_id=$(echo "$body" | jq -r '.transaction_id')
|
||||
if [ -z "$transaction_id" ] || [ "$transaction_id" = "null" ]; then
|
||||
echo "❌ transaction_id invalide dans la réponse"
|
||||
echo "$body"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Vérifier que transaction_id est un txid Bitcoin (64 hex)
|
||||
if ! echo "$transaction_id" | grep -qE '^[a-f0-9]{64}$'; then
|
||||
echo "❌ transaction_id n'est pas un txid Bitcoin valide (64 hex): $transaction_id"
|
||||
echo "$body"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo " ✅ Anchor OK (transaction_id/txid: $transaction_id)"
|
||||
|
||||
# Confirm status endpoint reachable (expected 200)
|
||||
echo "3. Status (OK case)"
|
||||
status_response=$(curl -s -w "\n%{http_code}" "$API_URL/api/anchor/status/$transaction_id" \
|
||||
-H "x-api-key: $API_KEY")
|
||||
|
||||
status_code=$(echo "$status_response" | tail -n1)
|
||||
status_body=$(echo "$status_response" | head -n -1)
|
||||
|
||||
if [ "$status_code" != "200" ]; then
|
||||
echo "❌ Status a retourné HTTP $status_code"
|
||||
echo "$status_body"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo " ✅ Status OK"
|
||||
|
||||
echo ""
|
||||
echo "🎉 Test OK terminé avec succès."
|
||||
167
test-api.sh
167
test-api.sh
@ -1,167 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Script de test pour l'API LeCoffre Anchor
|
||||
# Usage: ./test-api.sh [API_URL] [API_KEY]
|
||||
|
||||
# Charge les variables d'environnement depuis .env si disponible
|
||||
if [ -f ".env" ]; then
|
||||
set -o allexport
|
||||
# shellcheck disable=SC1091
|
||||
source ".env"
|
||||
set +o allexport
|
||||
fi
|
||||
|
||||
API_URL=${1:-"${ANCHORE_API_URL:-}"} # Pas de fallback : variable obligatoire
|
||||
API_KEY=${2:-"${ANCHORE_API_KEY:-}"} # Pas de fallback : variable obligatoire
|
||||
|
||||
if [ -z "$API_URL" ]; then
|
||||
echo "❌ ANCHORE_API_URL non défini (fournir la variable ou passer l'URL en argument)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -z "$API_KEY" ]; then
|
||||
echo "❌ ANCHORE_API_KEY non défini (fournir la variable ou passer la clé en argument)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "🧪 Test de l'API LeCoffre Anchor"
|
||||
echo "📍 URL: $API_URL"
|
||||
echo "🔑 API Key: ${API_KEY:0:8}..."
|
||||
echo ""
|
||||
|
||||
# Couleurs pour les logs
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Fonction pour tester un endpoint
|
||||
test_endpoint() {
|
||||
local name="$1"
|
||||
local method="$2"
|
||||
local endpoint="$3"
|
||||
local headers="$4"
|
||||
local data="$5"
|
||||
local expected_status="$6"
|
||||
|
||||
echo -n "Testing $name... "
|
||||
|
||||
local curl_cmd=(curl -s -w "\n%{http_code}" -X "$method" "$API_URL$endpoint")
|
||||
|
||||
if [ -n "$headers" ]; then
|
||||
# shellcheck disable=SC2206
|
||||
local header_array=()
|
||||
eval "header_array=($headers)"
|
||||
curl_cmd+=("${header_array[@]}")
|
||||
fi
|
||||
|
||||
if [ -n "$data" ]; then
|
||||
curl_cmd+=(-d "$data")
|
||||
fi
|
||||
|
||||
response=$("${curl_cmd[@]}")
|
||||
|
||||
http_code=$(echo "$response" | tail -n1)
|
||||
body=$(echo "$response" | head -n -1)
|
||||
|
||||
if [ "$http_code" = "$expected_status" ]; then
|
||||
echo -e "${GREEN}✓${NC} (HTTP $http_code)"
|
||||
else
|
||||
echo -e "${RED}✗${NC} (HTTP $http_code, expected $expected_status)"
|
||||
echo "Response: $body"
|
||||
fi
|
||||
}
|
||||
|
||||
# Test 1: Health Check
|
||||
echo "1. Health Check"
|
||||
test_endpoint "Health endpoint" "GET" "/health" "" "" "200"
|
||||
echo ""
|
||||
|
||||
# Test 2: Authentification
|
||||
echo "2. Authentification"
|
||||
test_endpoint "Sans API key" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\"" '{"documentUid":"test","hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}' "401"
|
||||
test_endpoint "Mauvaise API key" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\" -H \"x-api-key: wrong-key\"" '{"documentUid":"test","hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}' "401"
|
||||
test_endpoint "Bonne API key" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"documentUid":"test","hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}' "200"
|
||||
echo ""
|
||||
|
||||
# Test 3: Validation des données
|
||||
echo "3. Validation des données"
|
||||
test_endpoint "Hash invalide" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"documentUid":"test","hash":"invalid-hash"}' "400"
|
||||
test_endpoint "DocumentUid manquant" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}' "400"
|
||||
test_endpoint "Hash manquant" "POST" "/api/anchor/document" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"documentUid":"test"}' "400"
|
||||
echo ""
|
||||
|
||||
# Test 4: Endpoints fonctionnels
|
||||
echo "4. Endpoints fonctionnels"
|
||||
# Créer une transaction pour tester le statut
|
||||
transaction_response=$(curl -s -X POST "$API_URL/api/anchor/document" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "x-api-key: $API_KEY" \
|
||||
-d '{"documentUid":"test-status","hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}')
|
||||
|
||||
transaction_id=$(echo "$transaction_response" | jq -r '.transaction_id')
|
||||
echo "Transaction créée (txid Bitcoin): $transaction_id"
|
||||
|
||||
# Vérifier que transaction_id est un txid Bitcoin valide (64 hex)
|
||||
if ! echo "$transaction_id" | grep -qE '^[a-f0-9]{64}$'; then
|
||||
echo -e "${RED}✗${NC} transaction_id n'est pas un txid Bitcoin valide (64 hex): $transaction_id"
|
||||
echo "Response: $transaction_response"
|
||||
else
|
||||
echo -e "${GREEN}✓${NC} transaction_id est un txid Bitcoin valide"
|
||||
fi
|
||||
|
||||
test_endpoint "Statut transaction" "GET" "/api/anchor/status/$transaction_id" "-H \"x-api-key: $API_KEY\"" "" "200"
|
||||
# Test avec un txid Bitcoin invalide (mais format correct)
|
||||
test_endpoint "Transaction inexistante" "GET" "/api/anchor/status/0000000000000000000000000000000000000000000000000000000000000000" "-H \"x-api-key: $API_KEY\"" "" "404"
|
||||
echo ""
|
||||
|
||||
# Test 5: Vérification
|
||||
echo "5. Vérification"
|
||||
test_endpoint "Vérifier hash" "POST" "/api/anchor/verify" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"hash":"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"}' "200"
|
||||
test_endpoint "Hash invalide pour vérification" "POST" "/api/anchor/verify" "-H \"Content-Type: application/json\" -H \"x-api-key: $API_KEY\"" '{"hash":"invalid"}' "400"
|
||||
echo ""
|
||||
|
||||
# Test 6: CORS
|
||||
echo "6. CORS"
|
||||
echo -n "Testing CORS preflight... "
|
||||
cors_response=$(curl -s -H "Origin: http://malicious-site.com" \
|
||||
-H "Access-Control-Request-Method: POST" \
|
||||
-H "Access-Control-Request-Headers: x-api-key,content-type" \
|
||||
-X OPTIONS "$API_URL/api/anchor/document" -w "%{http_code}")
|
||||
|
||||
cors_code=$(echo "$cors_response" | tail -n1)
|
||||
if [ "$cors_code" = "204" ]; then
|
||||
echo -e "${YELLOW}⚠${NC} (HTTP $cors_code - CORS pourrait être trop permissif)"
|
||||
else
|
||||
echo -e "${GREEN}✓${NC} (HTTP $cors_code)"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# Test 7: Performance
|
||||
echo "7. Performance"
|
||||
echo -n "Testing 10 requests... "
|
||||
start_time=$(date +%s.%N)
|
||||
for i in {1..10}; do
|
||||
curl -s -X POST "$API_URL/api/anchor/document" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "x-api-key: $API_KEY" \
|
||||
-d "{\"documentUid\":\"perf-test-$i\",\"hash\":\"1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\"}" > /dev/null
|
||||
done
|
||||
end_time=$(date +%s.%N)
|
||||
duration=$(echo "$end_time - $start_time" | bc)
|
||||
rps=$(echo "scale=2; 10 / $duration" | bc)
|
||||
echo -e "${GREEN}✓${NC} ($rps req/s)"
|
||||
echo ""
|
||||
|
||||
echo "🎯 Tests terminés!"
|
||||
echo ""
|
||||
echo "📊 Résumé:"
|
||||
echo "- Health check: ✓"
|
||||
echo "- Authentification: ✓"
|
||||
echo "- Validation: ✓"
|
||||
echo "- Endpoints: ✓"
|
||||
echo "- Vérification: ✓"
|
||||
echo "- CORS: ⚠ (à vérifier)"
|
||||
echo "- Performance: ✓"
|
||||
echo ""
|
||||
echo "💡 Note: Le transaction_id est maintenant directement le txid Bitcoin (64 hex), consultable sur mempool."
|
||||
@ -1,36 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "commonjs",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"resolveJsonModule": true,
|
||||
"moduleResolution": "node",
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"sourceMap": true,
|
||||
"removeComments": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true,
|
||||
"noImplicitReturns": true,
|
||||
"noFallthroughCasesInSwitch": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true,
|
||||
"baseUrl": "./src",
|
||||
"paths": {
|
||||
"@controllers/*": ["controllers/*"],
|
||||
"@services/*": ["services/*"],
|
||||
"@config/*": ["config/*"],
|
||||
"@types/*": ["types/*"]
|
||||
}
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user