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

use crate::{crypto::hash::Hash, interfaces::BlockDate, time::SystemTime};
use serde::{Deserialize, Serialize};

/// log identifier in the leadership log. Can be used to update
/// back some.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct LeadershipLogId(BlockDate);

/// the status of a leadership log
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub enum LeadershipLogStatus {
    Pending,
    Rejected {
        reason: String,
    },
    Block {
        block: Hash,
        parent: Hash,
        chain_length: u32,
    },
}

/// provides information regarding events in the leadership schedule
///
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LeadershipLog {
    created_at_time: SystemTime,
    scheduled_at_time: SystemTime,
    scheduled_at_date: BlockDate,
    wake_at_time: Option<SystemTime>,
    finished_at_time: Option<SystemTime>,
    status: LeadershipLogStatus,
}

impl LeadershipLog {
    pub fn new(scheduled_at_date: BlockDate, scheduled_at_time: SystemTime) -> Self {
        LeadershipLog {
            created_at_time: SystemTime::now(),
            scheduled_at_time,
            scheduled_at_date,
            wake_at_time: None,
            finished_at_time: None,
            status: LeadershipLogStatus::Pending,
        }
    }

    /// retrieve a unique identifier to this log
    pub fn leadership_log_id(&self) -> LeadershipLogId {
        LeadershipLogId(self.scheduled_at_date)
    }

    pub fn created_at_time(&self) -> &SystemTime {
        &self.created_at_time
    }
    pub fn scheduled_at_date(&self) -> &BlockDate {
        &self.scheduled_at_date
    }
    pub fn scheduled_at_time(&self) -> &SystemTime {
        &self.scheduled_at_time
    }
    pub fn wake_at_time(&self) -> &Option<SystemTime> {
        &self.wake_at_time
    }
    pub fn finished_at_time(&self) -> &Option<SystemTime> {
        &self.finished_at_time
    }
    pub fn status(&self) -> &LeadershipLogStatus {
        &self.status
    }

    /// make a leadership event as triggered.
    ///
    /// This should be called when the leadership event has started.
    ///
    /// # panic
    ///
    /// on non-release build, this function will panic if the log was already
    /// marked as awaken.
    ///
    pub fn mark_wake(&mut self) {
        debug_assert!(self.wake_at_time.is_none());
        self.wake_at_time = Some(SystemTime::now())
    }

    /// make a leadership event as finished.
    ///
    /// This should be called when the leadership event has finished its
    /// scheduled action.
    ///
    /// # panic
    ///
    /// on non-release build, this function will panic if the log was already
    /// marked as finished.
    ///
    pub fn mark_finished(&mut self) {
        debug_assert!(self.finished_at_time.is_none());
        self.finished_at_time = Some(SystemTime::now())
    }

    /// set the leadership log status.
    pub fn set_status(&mut self, status: LeadershipLogStatus) {
        self.status = status
    }
}