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

//! Map pubkeys to stake delegations
//!
//! This module implements clone-on-write semantics for `StakeDelegations` to reduce unnecessary
//! cloning of the underlying map.
use {
    solana_sdk::{pubkey::Pubkey, stake::state::Delegation},
    std::{
        collections::HashMap,
        ops::{Deref, DerefMut},
        sync::Arc,
    },
};

/// A map of pubkey-to-stake-delegation with clone-on-write semantics
#[derive(Default, Clone, PartialEq, Debug, Deserialize, Serialize, AbiExample)]
pub struct StakeDelegations(Arc<StakeDelegationsInner>);

impl Deref for StakeDelegations {
    type Target = StakeDelegationsInner;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for StakeDelegations {
    fn deref_mut(&mut self) -> &mut Self::Target {
        Arc::make_mut(&mut self.0)
    }
}

/// The inner type, which maps pubkeys to stake delegations
type StakeDelegationsInner = HashMap<Pubkey, Delegation>;

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

    /// Ensure that StakeDelegations is indeed clone-on-write
    #[test]
    fn test_stake_delegations_is_cow() {
        let voter_pubkey = Pubkey::new_unique();
        let stake = rand::random();
        let activation_epoch = rand::random();
        let warmup_cooldown_rate = rand::random();
        let delegation =
            Delegation::new(&voter_pubkey, stake, activation_epoch, warmup_cooldown_rate);

        let pubkey = Pubkey::new_unique();

        let mut stake_delegations = StakeDelegations::default();
        stake_delegations.insert(pubkey, delegation);

        // Test: Clone the stake delegations and **do not modify**.  Assert the underlying maps are
        // the same instance.
        {
            let stake_delegations2 = stake_delegations.clone();
            assert_eq!(stake_delegations, stake_delegations2);
            assert!(
                Arc::ptr_eq(&stake_delegations.0, &stake_delegations2.0),
                "Inner Arc must point to the same HashMap"
            );
            assert!(
                std::ptr::eq(stake_delegations.deref(), stake_delegations2.deref()),
                "Deref must point to the same HashMap"
            );
        }

        // Test: Clone the stake delegations and then modify (remove the K-V, then re-add the same
        // one, so the stake delegations are still logically equal).  Assert the underlying maps
        // are unique instances.
        {
            let mut stake_delegations2 = stake_delegations.clone();
            stake_delegations2.clear();
            assert_ne!(stake_delegations, stake_delegations2);
            stake_delegations2.insert(pubkey, delegation);
            assert_eq!(stake_delegations, stake_delegations2);
            assert!(
                !Arc::ptr_eq(&stake_delegations.0, &stake_delegations2.0),
                "Inner Arc must point to different HashMaps"
            );
            assert!(
                !std::ptr::eq(stake_delegations.deref(), stake_delegations2.deref()),
                "Deref must point to different HashMaps"
            );
        }
    }

    /// Ensure that StakeDelegations serializes and deserializes between the inner and outer types
    #[test]
    fn test_stake_delegations_serde() {
        let voter_pubkey = Pubkey::new_unique();
        let stake = rand::random();
        let activation_epoch = rand::random();
        let warmup_cooldown_rate = rand::random();
        let delegation =
            Delegation::new(&voter_pubkey, stake, activation_epoch, warmup_cooldown_rate);

        let pubkey = Pubkey::new_unique();

        let mut stake_delegations_outer = StakeDelegations::default();
        stake_delegations_outer.insert(pubkey, delegation);

        let mut stake_delegations_inner = StakeDelegationsInner::default();
        stake_delegations_inner.insert(pubkey, delegation);

        // Test: Assert that serializing the outer and inner types produces the same data
        assert_eq!(
            bincode::serialize(&stake_delegations_outer).unwrap(),
            bincode::serialize(&stake_delegations_inner).unwrap(),
        );

        // Test: Assert that serializing the outer type then deserializing to the inner type
        // produces the same values
        {
            let data = bincode::serialize(&stake_delegations_outer).unwrap();
            let deserialized_inner: StakeDelegationsInner = bincode::deserialize(&data).unwrap();
            assert_eq!(&deserialized_inner, stake_delegations_outer.deref());
        }

        // Test: Assert that serializing the inner type then deserializing to the outer type
        // produces the same values
        {
            let data = bincode::serialize(&stake_delegations_inner).unwrap();
            let deserialized_outer: StakeDelegations = bincode::deserialize(&data).unwrap();
            assert_eq!(deserialized_outer.deref(), &stake_delegations_inner);
        }
    }
}