blvm-node 0.1.1

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
//! Tests for Module API Hub

#[path = "stub_node_api.rs"]
mod stub_node_api;

use blvm_node::module::api::hub::{AuditEntry, ModuleApiHub};
use blvm_node::module::ipc::protocol::{RequestMessage, RequestPayload, ResponsePayload};
use blvm_node::module::security::permissions::{Permission, PermissionSet};
use blvm_node::module::traits::ModuleError;
use blvm_protocol::{Hash, OutPoint};
use std::sync::Arc;

use stub_node_api::MockNodeAPI;

#[tokio::test]
async fn test_module_api_hub_new() {
    let node_api = Arc::new(MockNodeAPI);
    let hub = ModuleApiHub::new(node_api);
    // Hub should be created successfully
    assert!(true);
}

#[tokio::test]
async fn test_module_api_hub_register_permissions() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);

    hub.register_module_permissions("test-module".to_string(), permissions);
    // Permissions should be registered
    assert!(true);
}

#[tokio::test]
async fn test_module_api_hub_handle_handshake() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::Handshake,
        payload: RequestPayload::Handshake {
            module_id: "test-module".to_string(),
            module_name: "Test Module".to_string(),
            version: "1.0.0".to_string(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::HandshakeAck { node_version }) = response.payload {
        assert!(!node_version.is_empty());
    } else {
        panic!("Expected HandshakeAck");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_handshake_id_mismatch() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::Handshake,
        payload: RequestPayload::Handshake {
            module_id: "wrong-module".to_string(),
            module_name: "Test Module".to_string(),
            version: "1.0.0".to_string(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        ModuleError::OperationError(_)
    ));
}

#[tokio::test]
async fn test_module_api_hub_handle_get_chain_tip() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions (GetChainTip requires ReadChainState)
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadChainState);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetChainTip,
        payload: RequestPayload::GetChainTip,
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::Hash(hash)) = response.payload {
        assert_eq!(hash.len(), 32); // Hash is [u8; 32]
    } else {
        panic!("Expected Hash response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_get_block() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetBlock,
        payload: RequestPayload::GetBlock {
            hash: Hash::default(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::Block(block)) = response.payload {
        assert!(block.is_some());
    } else {
        panic!("Expected Block response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_get_block_header() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetBlockHeader,
        payload: RequestPayload::GetBlockHeader {
            hash: Hash::default(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::BlockHeader(header)) = response.payload {
        assert!(header.is_some());
    } else {
        panic!("Expected BlockHeader response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_get_transaction() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetTransaction,
        payload: RequestPayload::GetTransaction {
            hash: Hash::default(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::Transaction(tx)) = response.payload {
        assert!(tx.is_some());
    } else {
        panic!("Expected Transaction response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_has_transaction() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::HasTransaction,
        payload: RequestPayload::HasTransaction {
            hash: Hash::default(),
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::Bool(exists)) = response.payload {
        assert!(exists);
    } else {
        panic!("Expected Bool response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_get_block_height() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions (GetBlockHeight requires ReadChainState)
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadChainState);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetBlockHeight,
        payload: RequestPayload::GetBlockHeight,
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::U64(height)) = response.payload {
        assert_eq!(height, 100);
    } else {
        panic!("Expected U64 response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_get_utxo() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions (GetUtxo requires ReadUTXO)
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadUTXO);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetUtxo,
        payload: RequestPayload::GetUtxo {
            outpoint: OutPoint {
                hash: Hash::default(),
                index: 0,
            },
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::Utxo(utxo)) = response.payload {
        assert!(utxo.is_some());
    } else {
        panic!("Expected Utxo response");
    }
}

#[tokio::test]
async fn test_module_api_hub_handle_subscribe_events() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::SubscribeEvents);
    hub.register_module_permissions("test-module".to_string(), permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::SubscribeEvents,
        payload: RequestPayload::SubscribeEvents {
            event_types: vec![blvm_node::module::traits::EventType::NewBlock],
        },
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_ok(), "Request failed: {:?}", result);

    let response = result.unwrap();
    if let Some(ResponsePayload::SubscribeAck) = response.payload {
        // Success
    } else {
        panic!("Expected SubscribeAck response");
    }
}

#[tokio::test]
async fn test_module_api_hub_permission_denied() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register empty permissions to override defaults and test permission denied
    let empty_permissions = PermissionSet::new();
    hub.register_module_permissions("test-module".to_string(), empty_permissions);

    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetChainTip,
        payload: RequestPayload::GetChainTip,
    };

    let result = hub.handle_request("test-module", request).await;
    if let Err(e) = &result {
        eprintln!("Error: {:?}", e);
    }
    assert!(result.is_err(), "Expected permission denied error");
    // Permission errors are returned as OperationError, not PermissionDenied
    assert!(matches!(
        result.unwrap_err(),
        ModuleError::OperationError(_)
    ));
}

#[tokio::test]
async fn test_module_api_hub_audit_log() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions (GetChainTip requires ReadChainState)
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadChainState);
    hub.register_module_permissions("test-module".to_string(), permissions);

    // Make a request
    use blvm_node::module::ipc::protocol::MessageType;
    let request = RequestMessage {
        correlation_id: 1,
        request_type: MessageType::GetChainTip,
        payload: RequestPayload::GetChainTip,
    };

    let _ = hub.handle_request("test-module", request).await;

    // Check audit log
    let audit_log = hub.get_audit_log(10);
    assert!(!audit_log.is_empty());
    assert_eq!(audit_log[0].module_id, "test-module");
    assert_eq!(audit_log[0].api_call, "get_chain_tip");
    assert!(audit_log[0].success);
}

#[tokio::test]
async fn test_module_api_hub_audit_log_limit() {
    let node_api = Arc::new(MockNodeAPI);
    let mut hub = ModuleApiHub::new(node_api);

    // Register permissions
    let mut permissions = PermissionSet::new();
    permissions.add(Permission::ReadBlockchain);
    hub.register_module_permissions("test-module".to_string(), permissions);

    // Make many requests (more than max_audit_entries)
    use blvm_node::module::ipc::protocol::MessageType;
    for i in 0..1500 {
        let request = RequestMessage {
            correlation_id: i,
            request_type: MessageType::GetChainTip,
            payload: RequestPayload::GetChainTip,
        };
        let _ = hub.handle_request("test-module", request).await;
    }

    // Check audit log is limited
    let audit_log = hub.get_audit_log(2000);
    assert!(audit_log.len() <= 1000); // Should be limited to max_audit_entries
}