minbft 1.0.3

Efficient Byzantine Fault-Tolerance in the partially synchronous timing model
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
185
186
187
188
189
190
191
192
193
194

use crate::peer_message::{
    req_view_change::ReqViewChange,
    usig_message::{view_peer_message::ViewPeerMessage, UsigMessage},
};

use super::*;

/// Test if handling a timeout for a ClientRequest which has not been accepted yet
/// results in the broadcast of a message of type ReqViewChange for the subsequent View.
/// More precisely, tests if the Replica with id = 0 broadcasts a ReqViewChange when
/// the timeout for a ClientRequest is triggered.
/// The configuration used is n = 3, t = 1, checkpoint_period = 2.
#[test]
fn req_view_change() {
    let id = ReplicaId::from_u64(0);
    let ((mut minbft, _), mut timeout_handler) = minimal_setup(3, 1, id, 2);

    let output = minbft.handle_client_message(ClientId::from_u64(23), DummyPayload(56, true));

    assert_eq!(output.broadcasts.len(), 1);
    let broadcasts = Vec::from(output.broadcasts); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    let mut iter = broadcasts.into_iter();
    let message = iter
        .next()
        .unwrap()
        .validate(id, &minbft.config, &mut minbft.usig)
        .unwrap();
    assert!(matches!(
        message,
        ValidatedPeerMessage::Usig(UsigMessage::View(ViewPeerMessage::Prepare(_)))
    ));

    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);

    let timeout_requests = Vec::from(output.timeout_requests); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    assert_eq!(timeout_requests.len(), 2);
    let mut iter = timeout_requests.clone().into_iter();
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::Start(_)));
    if let TimeoutRequest::Start(timeout) = timeout_request {
        assert!(matches!(timeout.timeout_type, TimeoutType::Client));
        assert!(matches!(timeout.stop_class, StopClass(23)));
    } else {
        unreachable!();
    }
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::Stop(_)));
    if let TimeoutRequest::Stop(timeout) = timeout_request {
        assert!(matches!(timeout.timeout_type, TimeoutType::Batch));
        assert_eq!(timeout.stop_class, StopClass::default());
    } else {
        unreachable!();
    }

    timeout_handler.handle_timeout_requests(timeout_requests);
    let timeout_types = timeout_handler.retrieve_timeouts_ordered();
    assert_eq!(timeout_types.len(), 1);
    let mut iter = timeout_types.into_iter();
    let timeout_type = iter.next().unwrap();
    assert!(matches!(timeout_type, TimeoutType::Client));

    let output = minbft.handle_timeout(timeout_type);

    assert_eq!(output.broadcasts.len(), 1);
    let broadcasts = Vec::from(output.broadcasts); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    let mut iter = broadcasts.into_iter();
    let message = iter
        .next()
        .unwrap()
        .validate(id, &minbft.config, &mut minbft.usig)
        .unwrap();
    assert!(matches!(
        message,
        ValidatedPeerMessage::ReqViewChange(ReqViewChange {
            next_view: View(1),
            prev_view: View(0),
        })
    ));

    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);
    assert_eq!(output.timeout_requests.len(), 0);
}

/// Tests if a message of type ViewChange is broadcasted when sufficient Replicas broadcasted messages of type ReqViewChange.
/// More precisely, tests if the Replica with id = 0 broadcasts a ViewChange when both the Replica with id = 0 and the Replica
/// with id = 1 each broadcasted a ReqViewChange message previously.
/// The configuration used is n = 3, t = 1, checkpoint_period = 2.
#[test]
fn view_change() {
    let ((mut minbft_0, _), mut timeout_handler_0) = minimal_setup(3, 1, ReplicaId::from_u64(0), 2);
    let ((mut minbft_1, _), mut timeout_handler_1) = minimal_setup(3, 1, ReplicaId::from_u64(1), 2);

    let output = minbft_1.handle_client_message(ClientId::from_u64(23), DummyPayload(56, true));

    assert_eq!(output.broadcasts.len(), 0);
    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);

    let timeout_requests = Vec::from(output.timeout_requests); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    assert_eq!(timeout_requests.len(), 1);
    let mut iter = timeout_requests.clone().into_iter();
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::Start(_)));
    if let TimeoutRequest::Start(timeout) = timeout_request {
        assert!(matches!(timeout.timeout_type, TimeoutType::Client));
        assert!(matches!(timeout.stop_class, StopClass(23)));
    } else {
        unreachable!();
    }

    timeout_handler_1.handle_timeout_requests(timeout_requests);
    let timeout_types = timeout_handler_1.retrieve_timeouts_ordered();
    assert_eq!(timeout_types.len(), 1);
    let mut iter = timeout_types.into_iter();
    let timeout_type = iter.next().unwrap();
    assert!(matches!(timeout_type, TimeoutType::Client));

    let output = minbft_1.handle_timeout(timeout_type);
    assert_eq!(output.broadcasts.len(), 1);
    let broadcasts = Vec::from(output.broadcasts); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    let mut iter = broadcasts.into_iter();
    let message = iter.next().unwrap();
    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);
    assert_eq!(output.timeout_requests.len(), 0);

    let output = minbft_0.handle_client_message(ClientId::from_u64(23), DummyPayload(56, true));

    assert_eq!(output.broadcasts.len(), 1);
    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);

    let timeout_requests = Vec::from(output.timeout_requests); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    assert_eq!(timeout_requests.len(), 2);
    let mut iter = timeout_requests.clone().into_iter();
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::Start(_)));
    if let TimeoutRequest::Start(timeout) = timeout_request {
        assert!(matches!(timeout.timeout_type, TimeoutType::Client));
        assert!(matches!(timeout.stop_class, StopClass(23)));
    } else {
        unreachable!();
    }
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::Stop(_)));
    if let TimeoutRequest::Stop(timeout) = timeout_request {
        assert!(matches!(timeout.timeout_type, TimeoutType::Batch));
        assert_eq!(timeout.stop_class, StopClass::default());
    } else {
        unreachable!();
    }

    timeout_handler_0.handle_timeout_requests(timeout_requests);
    let timeout_types = timeout_handler_0.retrieve_timeouts_ordered();
    assert_eq!(timeout_types.len(), 1);
    let mut iter = timeout_types.into_iter();
    let timeout_type = iter.next().unwrap();
    assert!(matches!(timeout_type, TimeoutType::Client));

    let output = minbft_0.handle_timeout(timeout_type);
    assert_eq!(output.broadcasts.len(), 1);
    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);
    assert_eq!(output.timeout_requests.len(), 0);

    let output = minbft_0.handle_peer_message(ReplicaId::from_u64(1), message);
    assert_eq!(output.broadcasts.len(), 1);
    let broadcasts = Vec::from(output.broadcasts); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    let mut iter = broadcasts.into_iter();
    let message = iter
        .next()
        .unwrap()
        .validate(ReplicaId::from_u64(0), &minbft_0.config, &mut minbft_0.usig)
        .unwrap();
    assert!(matches!(
        message,
        ValidatedPeerMessage::Usig(UsigMessage::ViewChange(_))
    ));

    assert_eq!(output.responses.len(), 0);
    assert_eq!(output.errors.len(), 0);

    let timeout_requests = Vec::from(output.timeout_requests); // remove once https://github.com/rust-lang/rust/issues/59878 is fixed
    assert_eq!(timeout_requests.len(), 1);
    let mut iter = timeout_requests.clone().into_iter();
    let timeout_request = iter.next().unwrap();
    assert!(matches!(timeout_request, TimeoutRequest::StopAny(_)));

    timeout_handler_0.handle_timeout_requests(timeout_requests);
    let timeout_types = timeout_handler_0.retrieve_timeouts_ordered();
    assert_eq!(timeout_types.len(), 0);
}