agave-votor 4.1.2

Blockchain, Rebuilt for Scale
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

use {
    crossbeam_channel::{Sender, TrySendError},
    solana_clock::Slot,
    thiserror::Error,
};

#[derive(Debug, Error)]
pub enum CommitmentError {
    #[error("Failed to send commitment data, channel disconnected")]
    ChannelDisconnected,
}

#[derive(Debug, PartialEq)]
pub enum CommitmentType {
    /// Our node has voted notarize for the slot
    Notarize,
    /// We have observed a finalization certificate for the slot
    Finalized,
}

#[derive(Debug, PartialEq)]
pub struct CommitmentAggregationData {
    pub commitment_type: CommitmentType,
    pub slot: Slot,
}

pub fn update_commitment_cache(
    commitment_type: CommitmentType,
    slot: Slot,
    commitment_sender: &Sender<CommitmentAggregationData>,
) -> Result<(), CommitmentError> {
    match commitment_sender.try_send(CommitmentAggregationData {
        commitment_type,
        slot,
    }) {
        Err(TrySendError::Disconnected(_)) => {
            info!("commitment_sender has disconnected");
            return Err(CommitmentError::ChannelDisconnected);
        }
        Err(TrySendError::Full(_)) => error!("commitment_sender is backed up, something is wrong"),
        Ok(_) => (),
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use {super::*, crossbeam_channel::unbounded};

    #[test]
    fn test_update_commitment_cache() {
        let (commitment_sender, commitment_receiver) = unbounded();
        let slot = 3;
        let commitment_type = CommitmentType::Notarize;
        update_commitment_cache(commitment_type, slot, &commitment_sender)
            .expect("Failed to send commitment data");
        let received_data = commitment_receiver
            .try_recv()
            .expect("Failed to receive commitment data");
        assert_eq!(
            received_data,
            CommitmentAggregationData {
                commitment_type: CommitmentType::Notarize,
                slot,
            }
        );
        let slot = 5;
        let commitment_type = CommitmentType::Finalized;
        update_commitment_cache(commitment_type, slot, &commitment_sender)
            .expect("Failed to send commitment data");
        let received_data = commitment_receiver
            .try_recv()
            .expect("Failed to receive commitment data");
        assert_eq!(
            received_data,
            CommitmentAggregationData {
                commitment_type: CommitmentType::Finalized,
                slot,
            }
        );

        // Close the channel and ensure the error is returned
        drop(commitment_receiver);
        let result = update_commitment_cache(CommitmentType::Notarize, 7, &commitment_sender);
        assert!(matches!(result, Err(CommitmentError::ChannelDisconnected)));
    }
}