blvm-node 0.1.2

Bitcoin Commons BLVM: Minimal Bitcoin node implementation using blvm-protocol and blvm-consensus
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
//! Blockchain read-only API for modules
//!
//! Provides a convenient, read-only interface for modules to query blockchain data.
//! All operations are read-only and cannot modify consensus state.

use std::sync::Arc;

use crate::module::traits::{module_error_msg, ModuleError};
use crate::storage::chainstate::{ChainInfo, ChainParams};
use crate::storage::{blockstore::BlockMetadata, Storage};
use crate::{Block, BlockHeader, Hash, OutPoint, Transaction, UTXO};

/// Blockchain API for modules
///
/// Provides read-only access to blockchain data including blocks, transactions,
/// chain state, and UTXO information. All operations are safe for modules as
/// they cannot modify consensus state.
pub struct BlockchainApi {
    /// Storage reference for querying blockchain data
    storage: Arc<Storage>,
}

impl BlockchainApi {
    /// Create a new blockchain API
    pub fn new(storage: Arc<Storage>) -> Self {
        Self { storage }
    }

    /// Get a block by hash
    pub async fn get_block(&self, hash: &Hash) -> Result<Option<Block>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .blocks()
                    .get_block(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to get block", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get a block header by hash
    pub async fn get_block_header(&self, hash: &Hash) -> Result<Option<BlockHeader>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .blocks()
                    .get_header(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to get block header", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get a block by height
    pub async fn get_block_by_height(&self, height: u64) -> Result<Option<Block>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                // First get hash by height
                let hash = storage
                    .blocks()
                    .get_hash_by_height(height)
                    .map_err(|e| ModuleError::op_err("Failed to get hash by height", e))?;

                if let Some(hash) = hash {
                    // Then get block by hash
                    storage
                        .blocks()
                        .get_block(&hash)
                        .map_err(|e| ModuleError::op_err("Failed to get block", e))
                } else {
                    Ok(None)
                }
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get block hash by height
    pub async fn get_hash_by_height(&self, height: u64) -> Result<Option<Hash>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                storage
                    .blocks()
                    .get_hash_by_height(height)
                    .map_err(|e| ModuleError::op_err("Failed to get hash by height", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get block height by hash
    pub async fn get_height_by_hash(&self, hash: &Hash) -> Result<Option<u64>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .blocks()
                    .get_height_by_hash(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to get height by hash", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get blocks in a height range
    pub async fn get_blocks_by_height_range(
        &self,
        start: u64,
        end: u64,
    ) -> Result<Vec<Block>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                storage
                    .blocks()
                    .get_blocks_by_height_range(start, end)
                    .map_err(|e| ModuleError::op_err("Failed to get blocks by height range", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get block metadata (TX count, etc.) without loading full block
    pub async fn get_block_metadata(
        &self,
        hash: &Hash,
    ) -> Result<Option<BlockMetadata>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .blocks()
                    .get_block_metadata(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to get block metadata", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Check if a block exists
    pub async fn has_block(&self, hash: &Hash) -> Result<bool, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .blocks()
                    .has_block(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to check block existence", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get total number of blocks stored
    pub async fn block_count(&self) -> Result<usize, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                storage
                    .blocks()
                    .block_count()
                    .map_err(|e| ModuleError::op_err("Failed to get block count", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get recent headers for median time-past calculation
    pub async fn get_recent_headers(&self, count: usize) -> Result<Vec<BlockHeader>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                storage
                    .blocks()
                    .get_recent_headers(count)
                    .map_err(|e| ModuleError::op_err("Failed to get recent headers", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get a transaction by hash
    pub async fn get_transaction(&self, hash: &Hash) -> Result<Option<Transaction>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .transactions()
                    .get_transaction(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to get transaction", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Check if a transaction exists
    pub async fn has_transaction(&self, hash: &Hash) -> Result<bool, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let hash = *hash;
            move || {
                storage
                    .transactions()
                    .has_transaction(&hash)
                    .map_err(|e| ModuleError::op_err("Failed to check transaction existence", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get UTXO by outpoint
    pub async fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<UTXO>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let outpoint = *outpoint;
            move || {
                storage
                    .utxos()
                    .get_utxo(&outpoint)
                    .map_err(|e| ModuleError::op_err("Failed to get UTXO", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Check if a UTXO exists
    pub async fn has_utxo(&self, outpoint: &OutPoint) -> Result<bool, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            let outpoint = *outpoint;
            move || {
                storage
                    .utxos()
                    .has_utxo(&outpoint)
                    .map_err(|e| ModuleError::op_err("Failed to check UTXO existence", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get current chain information
    pub async fn get_chain_info(&self) -> Result<Option<ChainInfo>, ModuleError> {
        tokio::task::spawn_blocking({
            let storage = Arc::clone(&self.storage);
            move || {
                storage
                    .chain()
                    .load_chain_info()
                    .map_err(|e| ModuleError::op_err("Failed to get chain info", e))
            }
        })
        .await
        .map_err(|e| ModuleError::op_err("Task join error", e))?
    }

    /// Get current chain tip (highest block hash)
    pub async fn get_chain_tip(&self) -> Result<Hash, ModuleError> {
        let chain_info = self.get_chain_info().await?;
        chain_info.map(|info| info.tip_hash).ok_or_else(|| {
            ModuleError::OperationError(module_error_msg::CHAIN_NOT_INITIALIZED.to_string())
        })
    }

    /// Get current block height
    pub async fn get_block_height(&self) -> Result<u64, ModuleError> {
        let chain_info = self.get_chain_info().await?;
        chain_info.map(|info| info.height).ok_or_else(|| {
            ModuleError::OperationError(module_error_msg::CHAIN_NOT_INITIALIZED.to_string())
        })
    }

    /// Get chain parameters
    pub async fn get_chain_params(&self) -> Result<Option<ChainParams>, ModuleError> {
        let chain_info = self.get_chain_info().await?;
        Ok(chain_info.map(|info| info.chain_params))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::storage::Storage;
    use tempfile::TempDir;

    fn create_test_storage() -> (TempDir, Arc<Storage>) {
        let temp_dir = TempDir::new().unwrap();
        let storage = Arc::new(Storage::new(temp_dir.path()).unwrap());
        (temp_dir, storage)
    }

    #[tokio::test]
    async fn test_blockchain_api_creation() {
        let (_temp_dir, storage) = create_test_storage();
        let _api = BlockchainApi::new(storage);
        // Creation succeeded (no panic)
    }

    #[tokio::test]
    async fn test_get_block_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.get_block(&hash).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_block_header_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.get_block_header(&hash).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_block_by_height_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_block_by_height(0).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_hash_by_height_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_hash_by_height(0).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_height_by_hash_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.get_height_by_hash(&hash).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_blocks_by_height_range_empty() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_blocks_by_height_range(0, 10).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_empty());
    }

    #[tokio::test]
    async fn test_get_block_metadata_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.get_block_metadata(&hash).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_has_block_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.has_block(&hash).await;
        assert!(result.is_ok());
        assert!(!result.unwrap());
    }

    #[tokio::test]
    async fn test_block_count_empty() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.block_count().await;
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), 0);
    }

    #[tokio::test]
    async fn test_get_recent_headers_empty() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_recent_headers(10).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_empty());
    }

    #[tokio::test]
    async fn test_get_transaction_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.get_transaction(&hash).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_has_transaction_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let hash = [0u8; 32];

        let result = api.has_transaction(&hash).await;
        assert!(result.is_ok());
        assert!(!result.unwrap());
    }

    #[tokio::test]
    async fn test_get_utxo_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let outpoint = OutPoint {
            hash: [0u8; 32],
            index: 0,
        };

        let result = api.get_utxo(&outpoint).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_has_utxo_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);
        let outpoint = OutPoint {
            hash: [0u8; 32],
            index: 0,
        };

        let result = api.has_utxo(&outpoint).await;
        assert!(result.is_ok());
        assert!(!result.unwrap());
    }

    #[tokio::test]
    async fn test_get_chain_info_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_chain_info().await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_get_chain_tip_not_initialized() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_chain_tip().await;
        assert!(result.is_err());
        match result.unwrap_err() {
            ModuleError::OperationError(msg) => {
                assert!(msg.contains("Chain not initialized"));
            }
            _ => panic!("Expected OperationError"),
        }
    }

    #[tokio::test]
    async fn test_get_block_height_not_initialized() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_block_height().await;
        assert!(result.is_err());
        match result.unwrap_err() {
            ModuleError::OperationError(msg) => {
                assert!(msg.contains("Chain not initialized"));
            }
            _ => panic!("Expected OperationError"),
        }
    }

    #[tokio::test]
    async fn test_get_chain_params_nonexistent() {
        let (_temp_dir, storage) = create_test_storage();
        let api = BlockchainApi::new(storage);

        let result = api.get_chain_params().await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_none());
    }
}