hbbft 0.1.1

The Honey Badger of Byzantine Fault Tolerant Consensus Protocols
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

use bincode;
use failure::Fail;

use crate::fault_log;
use crate::subset;
use crate::threshold_decrypt;

/// Honey badger error variants.
#[derive(Debug, Fail)]
pub enum Error {
    /// Failed to serialize contribution.
    #[fail(display = "Error serializing contribution: {}", _0)]
    ProposeBincode(bincode::ErrorKind),
    /// Failed to instantiate `Subset`.
    #[fail(display = "Failed to instantiate Subset: {}", _0)]
    CreateSubset(subset::Error),
    /// Failed to input contribution to `Subset`.
    #[fail(display = "Failed to input contribution to Subset: {}", _0)]
    InputSubset(subset::Error),
    /// Failed to handle `Subset` message.
    #[fail(display = "Failed to handle Subset message: {}", _0)]
    HandleSubsetMessage(subset::Error),
    /// Failed to decrypt a contribution.
    #[fail(display = "Threshold decryption error: {}", _0)]
    ThresholdDecrypt(threshold_decrypt::Error),
    /// Unknown sender
    #[fail(display = "Unknown sender")]
    UnknownSender,
}

/// The result of `HoneyBadger` handling an input or a message.
pub type Result<T> = ::std::result::Result<T, Error>;

/// Faults detectable from receiving honey badger messages
#[derive(Clone, Debug, Fail, PartialEq)]
pub enum FaultKind {
    /// `HoneyBadger` received a decryption share for an unaccepted proposer.
    #[fail(display = "`HoneyBadger` received a decryption share for an unaccepted proposer.")]
    UnexpectedDecryptionShare,
    /// `HoneyBadger` was unable to deserialize a proposer's ciphertext.
    #[fail(display = "`HoneyBadger` was unable to deserialize a proposer's ciphertext.")]
    DeserializeCiphertext,
    /// `HoneyBadger` received an invalid ciphertext from the proposer.
    #[fail(display = "`HoneyBadger` received an invalid ciphertext from the proposer.")]
    InvalidCiphertext,
    /// `HoneyBadger` received a message with an invalid epoch.
    #[fail(display = "`HoneyBadger` received a message with an invalid epoch.")]
    UnexpectedHbMessageEpoch,
    /// `HoneyBadger` could not deserialize bytes (i.e. a serialized Batch) from a given proposer
    /// into a vector of transactions.
    #[fail(
        display = "`HoneyBadger` could not deserialize bytes (i.e. a serialized Batch) from a
                    given proposer into a vector of transactions."
    )]
    BatchDeserializationFailed,
    /// `HoneyBadger` received a fault from `Subset`.
    #[fail(display = "`HoneyBadger` received a fault from `Subset`.")]
    SubsetFault(subset::FaultKind),
    /// `HoneyBadger` received a fault from `ThresholdDecrypt`.
    #[fail(display = "`HoneyBadger` received a fault from `ThresholdDecrypt`.")]
    DecryptionFault(threshold_decrypt::FaultKind),
}

/// The type of fault log whose entries are `HoneyBadger` faults.
pub type FaultLog<N> = fault_log::FaultLog<N, FaultKind>;