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

//! # Governance Messages
//!
//! Message formats for governance operations.

use serde::{Deserialize, Serialize};
use std::fmt;

// No error types needed for this module

/// A governance message that can be signed
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum GovernanceMessage {
    /// A release message
    Release {
        version: String,
        commit_hash: String,
    },
    /// A module approval message
    ModuleApproval {
        module_name: String,
        version: String,
    },
    /// A budget decision message
    BudgetDecision { amount: u64, purpose: String },
}

impl GovernanceMessage {
    /// Convert the message to bytes for signing
    pub fn to_signing_bytes(&self) -> Vec<u8> {
        // Use a standardized format for signing
        match self {
            GovernanceMessage::Release {
                version,
                commit_hash,
            } => format!("RELEASE:{version}:{commit_hash}").into_bytes(),
            GovernanceMessage::ModuleApproval {
                module_name,
                version,
            } => format!("MODULE:{module_name}:{version}").into_bytes(),
            GovernanceMessage::BudgetDecision { amount, purpose } => {
                format!("BUDGET:{amount}:{purpose}").into_bytes()
            }
        }
    }

    /// Get a human-readable description of the message
    pub fn description(&self) -> String {
        match self {
            GovernanceMessage::Release {
                version,
                commit_hash,
            } => {
                format!("Release {version} (commit: {commit_hash})")
            }
            GovernanceMessage::ModuleApproval {
                module_name,
                version,
            } => {
                format!("Approve module {module_name} version {version}")
            }
            GovernanceMessage::BudgetDecision { amount, purpose } => {
                format!("Budget decision: {amount} satoshis for {purpose}")
            }
        }
    }
}

impl fmt::Display for GovernanceMessage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.description())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_release_message() {
        let message = GovernanceMessage::Release {
            version: "v1.0.0".to_string(),
            commit_hash: "abc123".to_string(),
        };

        let bytes = message.to_signing_bytes();
        assert_eq!(bytes, b"RELEASE:v1.0.0:abc123");
        assert_eq!(message.description(), "Release v1.0.0 (commit: abc123)");
    }

    #[test]
    fn test_module_approval_message() {
        let message = GovernanceMessage::ModuleApproval {
            module_name: "lightning".to_string(),
            version: "v2.0.0".to_string(),
        };

        let bytes = message.to_signing_bytes();
        assert_eq!(bytes, b"MODULE:lightning:v2.0.0");
        assert_eq!(
            message.description(),
            "Approve module lightning version v2.0.0"
        );
    }

    #[test]
    fn test_budget_decision_message() {
        let message = GovernanceMessage::BudgetDecision {
            amount: 1000000,
            purpose: "development".to_string(),
        };

        let bytes = message.to_signing_bytes();
        assert_eq!(bytes, b"BUDGET:1000000:development");
        assert_eq!(
            message.description(),
            "Budget decision: 1000000 satoshis for development"
        );
    }

    #[test]
    fn test_message_serialization() {
        let message = GovernanceMessage::Release {
            version: "v1.0.0".to_string(),
            commit_hash: "abc123".to_string(),
        };

        let json = serde_json::to_string(&message).unwrap();
        let deserialized: GovernanceMessage = serde_json::from_str(&json).unwrap();

        assert_eq!(message, deserialized);
    }
}