blvm-sdk 0.1.4

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

//! # Message Format Tests
//!
//! Tests for message serialization and format consistency.

use blvm_sdk::governance::GovernanceMessage;

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

    let signing_bytes = message.to_signing_bytes();
    assert_eq!(signing_bytes, b"RELEASE:v1.0.0:abc123def456");

    let description = message.description();
    assert_eq!(description, "Release v1.0.0 (commit: abc123def456)");
}

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

    let signing_bytes = message.to_signing_bytes();
    assert_eq!(signing_bytes, b"MODULE:lightning-network:v2.0.0");

    let description = message.description();
    assert_eq!(
        description,
        "Approve module lightning-network version v2.0.0"
    );
}

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

    let signing_bytes = message.to_signing_bytes();
    assert_eq!(signing_bytes, b"BUDGET:1000000:development and maintenance");

    let description = message.description();
    assert_eq!(
        description,
        "Budget decision: 1000000 satoshis for development and maintenance"
    );
}

#[test]
fn test_message_serialization_roundtrip() {
    let messages = vec![
        GovernanceMessage::Release {
            version: "v1.0.0".to_string(),
            commit_hash: "abc123".to_string(),
        },
        GovernanceMessage::ModuleApproval {
            module_name: "lightning".to_string(),
            version: "v2.0.0".to_string(),
        },
        GovernanceMessage::BudgetDecision {
            amount: 1000000,
            purpose: "development".to_string(),
        },
    ];

    for message in messages {
        let json = serde_json::to_string(&message).unwrap();
        let deserialized: GovernanceMessage = serde_json::from_str(&json).unwrap();
        assert_eq!(message, deserialized);
    }
}

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

    let message2 = GovernanceMessage::Release {
        version: "v1.0.0".to_string(),
        commit_hash: "abc123".to_string(),
    };

    // Same message should produce same signing bytes
    assert_eq!(message1.to_signing_bytes(), message2.to_signing_bytes());
}

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

    let message2 = GovernanceMessage::Release {
        version: "v1.0.0".to_string(),
        commit_hash: "def456".to_string(),
    };

    // Different messages should produce different signing bytes
    assert_ne!(message1.to_signing_bytes(), message2.to_signing_bytes());
}

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

    let display_str = format!("{message}");
    assert_eq!(display_str, "Release v1.0.0 (commit: abc123)");
}

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

    let message2 = GovernanceMessage::Release {
        version: "v1.0.0".to_string(),
        commit_hash: "abc123".to_string(),
    };

    let message3 = GovernanceMessage::Release {
        version: "v1.0.0".to_string(),
        commit_hash: "def456".to_string(),
    };

    // Same messages should be equal
    assert_eq!(message1, message2);

    // Different messages should not be equal
    assert_ne!(message1, message3);
}

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

    let signing_bytes = message.to_signing_bytes();
    let expected = b"BUDGET:1000000:development & maintenance (2024)";

    assert_eq!(signing_bytes, expected);
}

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

    let signing_bytes = message.to_signing_bytes();
    assert_eq!(signing_bytes, b"RELEASE::");

    let description = message.description();
    assert_eq!(description, "Release  (commit: )");
}

#[test]
fn test_message_unicode_support() {
    let message = GovernanceMessage::BudgetDecision {
        amount: 1000000,
        purpose: "开发与维护".to_string(), // Chinese characters
    };

    let signing_bytes = message.to_signing_bytes();
    let expected = b"BUDGET:1000000:\xE5\xBC\x80\xE5\x8F\x91\xE4\xB8\x8E\xE7\xBB\xB4\xE6\x8A\xA4";

    assert_eq!(signing_bytes, expected);
}