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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
use crate::certificate::{PoolId, PoolRegistration, PoolRegistrationHash};
use crate::date::Epoch;
use crate::value::Value;
use imhamt::Hamt;
use std::collections::hash_map::DefaultHasher;
use std::fmt::{self, Debug};
use std::sync::Arc;

/// A structure that keeps track of stake keys and stake pools.
#[derive(Clone, PartialEq, Eq, Default)]
pub struct PoolsState {
    pub(crate) stake_pools: Hamt<DefaultHasher, PoolId, PoolState>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PoolError {
    AlreadyExists(PoolId),
    NotFound(PoolId),
}

#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct PoolLastRewards {
    pub epoch: Epoch,
    pub value_taxed: Value,
    pub value_for_stakers: Value,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PoolState {
    pub last_rewards: PoolLastRewards,
    pub registration: Arc<PoolRegistration>,
}

impl PoolState {
    pub fn new(reg: PoolRegistration) -> Self {
        PoolState {
            last_rewards: PoolLastRewards::default(),
            registration: Arc::new(reg),
        }
    }

    pub fn current_pool_registration_hash(&self) -> PoolRegistrationHash {
        self.registration.to_id()
    }
}

impl Debug for PoolsState {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{:?}",
            self.stake_pools
                .iter()
                .map(|(id, stake)| (id.clone(), stake.clone()))
                .collect::<Vec<(PoolId, PoolState)>>()
        )
    }
}

impl std::fmt::Display for PoolError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            PoolError::AlreadyExists(pool_id) => write!(
                f,
                "Block attempts to register pool '{:?}' which already exists",
                pool_id
            ),
            PoolError::NotFound(pool_id) => write!(
                f,
                "Block references a pool '{:?}' which does not exist",
                pool_id
            ),
        }
    }
}

impl std::error::Error for PoolError {}

impl PoolsState {
    pub fn new() -> Self {
        PoolsState {
            stake_pools: Hamt::new(),
        }
    }

    pub fn lookup(&self, id: &PoolId) -> Option<&PoolState> {
        self.stake_pools.lookup(id)
    }

    pub fn lookup_reg(&self, id: &PoolId) -> Option<&PoolRegistration> {
        self.stake_pools.lookup(id).map(|x| x.registration.as_ref())
    }

    pub fn stake_pool_ids(&self) -> impl Iterator<Item = PoolId> + '_ {
        self.stake_pools.iter().map(|(id, _)| id.clone())
    }

    pub fn stake_pool_exists(&self, pool_id: &PoolId) -> bool {
        self.stake_pools
            .lookup(pool_id)
            .map_or_else(|| false, |_| true)
    }

    pub fn stake_pool_get_state(&self, pool_id: &PoolId) -> Result<&PoolState, PoolError> {
        self.stake_pools
            .lookup(pool_id)
            .ok_or_else(|| PoolError::NotFound(pool_id.clone()))
    }

    pub fn stake_pool_set_state(
        &mut self,
        pool_id: &PoolId,
        pool_state: PoolState,
    ) -> Result<(), PoolError> {
        self.stake_pools = self
            .stake_pools
            .replace(pool_id, pool_state)
            .map(|r| r.0)
            .map_err(|_| PoolError::NotFound(pool_id.clone()))?;
        Ok(())
    }

    pub fn stake_pool_get(&self, pool_id: &PoolId) -> Result<&PoolRegistration, PoolError> {
        self.stake_pools
            .lookup(pool_id)
            .ok_or_else(|| PoolError::NotFound(pool_id.clone()))
            .map(|s| s.registration.as_ref())
    }

    pub fn stake_pool_set_rewards(
        &mut self,
        pool_id: &PoolId,
        epoch: Epoch,
        value_taxed: Value,
        value_for_stakers: Value,
    ) -> Result<(), PoolError> {
        let rw = PoolLastRewards {
            epoch,
            value_taxed,
            value_for_stakers,
        };
        self.stake_pools = self
            .stake_pools
            .replace_with(pool_id, |st| {
                let mut st = st.clone();
                st.last_rewards = rw;
                st
            })
            .map_err(|_| PoolError::NotFound(pool_id.clone()))?;
        Ok(())
    }

    pub fn register_stake_pool(&self, owner: PoolRegistration) -> Result<Self, PoolError> {
        let id = owner.to_id();
        let new_pools = self
            .stake_pools
            .insert(id.clone(), PoolState::new(owner))
            .map_err(|_| PoolError::AlreadyExists(id))?;
        Ok(PoolsState {
            stake_pools: new_pools,
        })
    }

    pub fn deregister_stake_pool(&self, pool_id: &PoolId) -> Result<Self, PoolError> {
        Ok(PoolsState {
            stake_pools: self
                .stake_pools
                .remove(pool_id)
                .map_err(|_| PoolError::NotFound(pool_id.clone()))?,
        })
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use crate::certificate::PoolRegistration;
    use quickcheck::{Arbitrary, Gen, TestResult};
    use quickcheck_macros::quickcheck;
    use std::iter;

    impl Arbitrary for PoolsState {
        fn arbitrary<G: Gen>(gen: &mut G) -> Self {
            let size = usize::arbitrary(gen);
            let arbitrary_stake_pools: Vec<PoolRegistration> =
                iter::from_fn(|| Some(PoolRegistration::arbitrary(gen)))
                    .take(size)
                    .collect();
            let mut delegation_state = PoolsState::new();
            for stake_pool in arbitrary_stake_pools {
                delegation_state = delegation_state.register_stake_pool(stake_pool).unwrap();
            }
            delegation_state
        }
    }

    impl Arbitrary for PoolState {
        fn arbitrary<G: Gen>(gen: &mut G) -> Self {
            let registration = Arc::new(PoolRegistration::arbitrary(gen));
            PoolState {
                last_rewards: PoolLastRewards::arbitrary(gen),
                registration,
            }
        }
    }

    impl Arbitrary for PoolLastRewards {
        fn arbitrary<G: Gen>(gen: &mut G) -> Self {
            PoolLastRewards {
                value_for_stakers: Value(u64::arbitrary(gen)),
                value_taxed: Value(u64::arbitrary(gen)),
                epoch: u32::arbitrary(gen),
            }
        }
    }

    #[quickcheck]
    pub fn delegation_state_tests(
        delegation_state: PoolsState,
        stake_pool: PoolRegistration,
    ) -> TestResult {
        // register stake pool first time should be ok
        let delegation_state = match delegation_state.register_stake_pool(stake_pool.clone()) {
            Ok(delegation_state) => delegation_state,
            Err(err) => {
                return TestResult::error(format!("Cannot register stake pool, due to {:?}", err))
            }
        };

        // register stake pool again should throw error
        if delegation_state
            .register_stake_pool(stake_pool.clone())
            .is_ok()
        {
            return TestResult::error(
                "Register the same stake pool twice should return error while it didn't",
            );
        }

        let stake_pool_id = stake_pool.to_id();

        // stake pool should be in collection
        if !delegation_state
            .stake_pool_ids()
            .any(|x| x == stake_pool_id)
        {
            return TestResult::error(format!(
                "stake pool with id: {:?} should exist in iterator",
                stake_pool_id
            ));
        };

        // stake pool should exist in collection
        if !delegation_state.stake_pool_exists(&stake_pool_id) {
            TestResult::error(format!(
                "stake pool with id {:?} should exist in collection",
                stake_pool_id
            ));
        }

        // deregister stake pool should be ok
        let delegation_state = match delegation_state.deregister_stake_pool(&stake_pool_id) {
            Ok(delegation_state) => delegation_state,
            Err(err) => {
                return TestResult::error(format!("Cannot deregister stake pool due to: {:?}", err))
            }
        };

        // deregister stake pool again should throw error
        if delegation_state
            .deregister_stake_pool(&stake_pool_id)
            .is_ok()
        {
            return TestResult::error(
                "Deregister the same stake pool twice should return error while it didn't",
            );
        }

        // stake pool should not exist in collection
        if delegation_state.stake_pool_exists(&stake_pool_id) {
            return TestResult::error(format!(
                "stake pool with id should be removed from collection {:?}",
                stake_pool_id
            ));
        }

        // stake pool should not be in collection
        if delegation_state
            .stake_pool_ids()
            .any(|x| x == stake_pool_id)
        {
            return TestResult::error(format!(
                "stake pool with id should be removed from iterator {:?}",
                stake_pool_id
            ));
        }

        TestResult::passed()
    }
}