blvm-sdk 0.1.1

Bitcoin Commons software developer kit, governance infrastructure and composition framework for Bitcoin
Documentation 
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

//! Node Composer
//!
//! High-level API for composing Bitcoin nodes from modules.

use crate::composition::config::NodeConfig;
use crate::composition::lifecycle::ModuleLifecycle;
use crate::composition::registry::ModuleRegistry;
use crate::composition::schema::validate_config_schema;
use crate::composition::types::*;
use crate::composition::validation::validate_composition;
use std::path::Path;

/// Node composer for building nodes from modules
pub struct NodeComposer {
    /// Module lifecycle manager (owns the registry)
    lifecycle: ModuleLifecycle,
}

impl NodeComposer {
    /// Create a new node composer
    pub fn new<P: AsRef<Path>>(modules_dir: P) -> Self {
        let registry = ModuleRegistry::new(modules_dir);
        let lifecycle = ModuleLifecycle::new(registry);

        Self { lifecycle }
    }

    /// Compose node from configuration file
    pub async fn compose_from_config<P: AsRef<Path>>(
        &mut self,
        config_path: P,
    ) -> Result<ComposedNode> {
        // Load configuration
        let config = NodeConfig::from_file(config_path)?;

        // Validate schema
        let schema_validation = validate_config_schema(&config)?;
        if !schema_validation.valid {
            return Err(CompositionError::ValidationFailed(format!(
                "Schema validation failed: {:?}",
                schema_validation.errors
            )));
        }

        // Convert to spec
        let spec = config.to_spec()?;

        // Compose from spec
        self.compose_node(spec).await
    }

    /// Compose node from specification
    pub async fn compose_node(&mut self, spec: NodeSpec) -> Result<ComposedNode> {
        // Validate composition
        let validation = self.validate_composition(&spec)?;
        if !validation.valid {
            return Err(CompositionError::ValidationFailed(format!(
                "Composition validation failed: {:?}",
                validation.errors
            )));
        }

        // Load all modules
        let mut loaded_modules = Vec::new();
        for module_spec in &spec.modules {
            if !module_spec.enabled {
                continue;
            }

            let info = self
                .lifecycle
                .registry
                .get_module(&module_spec.name, module_spec.version.as_deref())?;

            // Start module via lifecycle with config from ModuleSpec
            self.lifecycle_mut()
                .start_module(&info.name, Some(&module_spec.config))
                .await?;
            let status = self.lifecycle().get_module_status(&info.name).await?;
            let health = self.lifecycle().health_check(&info.name).await?;

            loaded_modules.push(LoadedModule {
                info,
                status,
                health,
            });
        }

        Ok(ComposedNode {
            spec,
            modules: loaded_modules,
            status: NodeStatus::Running,
        })
    }

    /// Validate composition
    pub fn validate_composition(&self, spec: &NodeSpec) -> Result<ValidationResult> {
        validate_composition(spec, &self.lifecycle.registry)
    }

    /// Generate configuration template
    pub fn generate_config(&self) -> String {
        let config = NodeConfig::template();
        toml::to_string_pretty(&config)
            .unwrap_or_else(|_| "# Error generating config template".to_string())
    }

    /// Get module registry (via lifecycle)
    pub fn registry(&self) -> &ModuleRegistry {
        &self.lifecycle.registry
    }

    /// Get mutable module registry (via lifecycle)
    pub fn registry_mut(&mut self) -> &mut ModuleRegistry {
        &mut self.lifecycle.registry
    }

    /// Get module lifecycle manager
    pub fn lifecycle(&self) -> &ModuleLifecycle {
        &self.lifecycle
    }

    /// Get mutable module lifecycle manager
    pub fn lifecycle_mut(&mut self) -> &mut ModuleLifecycle {
        &mut self.lifecycle
    }
}