blvm-sdk 0.1.3

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

//! blvm-registry - Registry index generator
//!
//! Scans a modules directory for module.toml files and emits a JSON registry index.
//! Use for building a registry from local module sources.
//!
//! Example:
//!   blvm-registry index --dir ./modules --output index.json

use blvm_node::module::registry::ModuleDiscovery;
use blvm_node::module::traits::ModuleError;
use clap::{Parser, Subcommand};
use serde::Serialize;
use std::path::PathBuf;

#[derive(Parser)]
#[command(name = "blvm-registry")]
#[command(about = "BLVM module registry index generator")]
struct Cli {
    #[command(subcommand)]
    command: Option<Commands>,
}

#[derive(Subcommand)]
enum Commands {
    /// Generate registry index from module.toml files in a directory
    Index {
        /// Directory containing modules (subdirs with module.toml)
        #[arg(short, long, default_value = "./modules")]
        dir: PathBuf,

        /// Output file (default: stdout)
        #[arg(short, long)]
        output: Option<PathBuf>,

        /// Base URL for download_url (e.g. https://registry.example.com/)
        #[arg(long)]
        registry_url: Option<String>,
    },
}

#[derive(Serialize)]
struct RegistryIndex {
    version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    registry_url: Option<String>,
    updated_at: String,
    modules: Vec<RegistryModule>,
}

#[derive(Serialize)]
struct RegistryModule {
    name: String,
    version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    author: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    download_url: Option<String>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    capabilities: Vec<String>,
    #[serde(skip_serializing_if = "std::collections::HashMap::is_empty")]
    dependencies: std::collections::HashMap<String, String>,
    #[serde(skip_serializing_if = "std::collections::HashMap::is_empty")]
    optional_dependencies: std::collections::HashMap<String, String>,
}

fn run_index(
    dir: PathBuf,
    output: Option<PathBuf>,
    registry_url: Option<String>,
) -> Result<(), Box<dyn std::error::Error>> {
    let discovery = ModuleDiscovery::new(&dir);
    let discovered = discovery
        .discover_modules()
        .map_err(|e: ModuleError| e.to_string())?;

    let modules: Vec<RegistryModule> = discovered
        .iter()
        .map(|d| {
            let download_url = registry_url.as_ref().map(|base| {
                let base = base.trim_end_matches('/');
                format!(
                    "{}/modules/{}-{}.tar.gz",
                    base, d.manifest.name, d.manifest.version
                )
            });
            RegistryModule {
                name: d.manifest.name.clone(),
                version: d.manifest.version.clone(),
                description: d.manifest.description.clone(),
                author: d.manifest.author.clone(),
                download_url,
                capabilities: d.manifest.capabilities.clone(),
                dependencies: d.manifest.dependencies.clone(),
                optional_dependencies: d.manifest.optional_dependencies.clone(),
            }
        })
        .collect();

    let index = RegistryIndex {
        version: "1".to_string(),
        registry_url: registry_url.clone(),
        updated_at: chrono::Utc::now().to_rfc3339(),
        modules,
    };

    let json = serde_json::to_string_pretty(&index)?;

    if let Some(path) = output {
        std::fs::write(&path, json)?;
        println!(
            "Wrote {} modules to {}",
            index.modules.len(),
            path.display()
        );
    } else {
        println!("{json}");
    }

    Ok(())
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cli = Cli::parse();

    match cli.command {
        Some(Commands::Index {
            dir,
            output,
            registry_url,
        }) => run_index(dir, output, registry_url),
        None => {
            println!("Run with --help for usage");
            Ok(())
        }
    }
}