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
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

//! Type Conversions
//!
//! Conversions between blvm-sdk composition types and blvm-node module types.

use crate::composition::types::ModuleInfo;
use blvm_node::module::registry::DiscoveredModule as RefDiscoveredModule;
use blvm_node::module::traits::ModuleError as RefModuleError;
use blvm_node::module::traits::ModuleMetadata as RefModuleMetadata;
use std::collections::HashMap;

impl From<&RefDiscoveredModule> for ModuleInfo {
    fn from(discovered: &RefDiscoveredModule) -> Self {
        ModuleInfo {
            name: discovered.manifest.name.clone(),
            version: discovered.manifest.version.clone(),
            description: discovered.manifest.description.clone(),
            author: discovered.manifest.author.clone(),
            capabilities: discovered.manifest.capabilities.clone(),
            dependencies: discovered.manifest.dependencies.clone(),
            entry_point: discovered.manifest.entry_point.clone(),
            directory: Some(discovered.directory.clone()),
            binary_path: Some(discovered.binary_path.clone()),
            config_schema: discovered.manifest.config_schema.clone(),
        }
    }
}

impl From<RefDiscoveredModule> for ModuleInfo {
    fn from(discovered: RefDiscoveredModule) -> Self {
        Self::from(&discovered)
    }
}

impl From<&RefModuleMetadata> for ModuleInfo {
    fn from(metadata: &RefModuleMetadata) -> Self {
        ModuleInfo {
            name: metadata.name.clone(),
            version: metadata.version.clone(),
            description: Some(metadata.description.clone()),
            author: Some(metadata.author.clone()),
            capabilities: metadata.capabilities.clone(),
            dependencies: metadata.dependencies.clone(),
            entry_point: metadata.entry_point.clone(),
            directory: None,
            binary_path: None,
            config_schema: HashMap::new(),
        }
    }
}

impl From<RefModuleMetadata> for ModuleInfo {
    fn from(metadata: RefModuleMetadata) -> Self {
        Self::from(&metadata)
    }
}

impl From<ModuleInfo> for RefModuleMetadata {
    fn from(info: ModuleInfo) -> Self {
        RefModuleMetadata {
            name: info.name,
            version: info.version,
            description: info.description.unwrap_or_default(),
            author: info.author.unwrap_or_default(),
            capabilities: info.capabilities,
            dependencies: info.dependencies,
            optional_dependencies: HashMap::new(), // ModuleInfo doesn't track optional deps separately
            entry_point: info.entry_point,
        }
    }
}

impl From<RefModuleError> for crate::composition::types::CompositionError {
    fn from(err: RefModuleError) -> Self {
        match err {
            RefModuleError::CryptoError(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Crypto error: {msg}"
                ))
            }
            RefModuleError::ModuleNotFound(name) => {
                crate::composition::types::CompositionError::ModuleNotFound(name)
            }
            RefModuleError::InvalidManifest(msg) => {
                crate::composition::types::CompositionError::InvalidConfiguration(msg)
            }
            RefModuleError::OperationError(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(msg)
            }
            RefModuleError::DependencyMissing(msg) => {
                crate::composition::types::CompositionError::DependencyResolutionFailed(msg)
            }
            RefModuleError::PermissionDenied(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Permission denied: {msg}"
                ))
            }
            RefModuleError::IpcError(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "IPC error: {msg}"
                ))
            }
            RefModuleError::InitializationError(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Initialization error: {msg}"
                ))
            }
            RefModuleError::VersionIncompatible(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Version incompatible: {msg}"
                ))
            }
            RefModuleError::ModuleCrashed(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Module crashed: {msg}"
                ))
            }
            RefModuleError::SerializationError(msg) => {
                crate::composition::types::CompositionError::SerializationError(msg)
            }
            RefModuleError::RateLimitExceeded(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Rate limit exceeded: {msg}"
                ))
            }
            RefModuleError::Timeout => {
                crate::composition::types::CompositionError::InstallationFailed(
                    "Timeout waiting for module response".to_string(),
                )
            }
            RefModuleError::ResourceLimitExceeded(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Resource limit exceeded: {msg}"
                ))
            }
            RefModuleError::Config(msg) => {
                crate::composition::types::CompositionError::InvalidConfiguration(msg)
            }
            RefModuleError::Rpc(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "RPC error: {msg}"
                ))
            }
            RefModuleError::Migration(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "Migration error: {msg}"
                ))
            }
            RefModuleError::Cli(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(format!(
                    "CLI error: {msg}"
                ))
            }
            RefModuleError::Other(msg) => {
                crate::composition::types::CompositionError::InstallationFailed(msg)
            }
        }
    }
}