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
use crate::error::{Error, Result};
use bitcoin::{hashes::Hash, BlockHash, Txid};
use core::fmt;

#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum SequenceMessage {
    BlockConnect { blockhash: BlockHash },
    BlockDisconnect { blockhash: BlockHash },
    MempoolAcceptance { txid: Txid, mempool_sequence: u64 },
    MempoolRemoval { txid: Txid, mempool_sequence: u64 },
}

impl SequenceMessage {
    /// Returns the length of this [`SequenceMessage`] when serialized.
    pub fn raw_length(&self) -> usize {
        match self {
            Self::BlockConnect { .. } | Self::BlockDisconnect { .. } => 33,
            Self::MempoolAcceptance { .. } | Self::MempoolRemoval { .. } => 41,
        }
    }

    /// Returns the label of this [`SequenceMessage`] as a [`char`].
    pub fn label_char(&self) -> char {
        self.label() as char
    }

    /// Returns the label of this [`SequenceMessage`] as a [`u8`].
    pub fn label(&self) -> u8 {
        match self {
            Self::BlockConnect { .. } => b'C',
            Self::BlockDisconnect { .. } => b'D',
            Self::MempoolAcceptance { .. } => b'A',
            Self::MempoolRemoval { .. } => b'R',
        }
    }

    /// Returns the contained hash (block hash or txid) of this [`SequenceMessage`].
    pub fn into_inner(self) -> [u8; 32] {
        let mut arr = match self {
            Self::BlockConnect { blockhash } | Self::BlockDisconnect { blockhash } => {
                blockhash.to_byte_array()
            }
            Self::MempoolAcceptance { txid, .. } | Self::MempoolRemoval { txid, .. } => {
                txid.to_byte_array()
            }
        };
        arr.reverse();
        arr
    }

    /// Returns the mempool sequence of this [`SequenceMessage`] if it is [`MempoolAcceptance`] or
    /// [`MempoolRemoval`]. This is a number that starts at 1 and goes up every time Bitcoin Core
    /// adds or removes a transaction to the mempool.
    ///
    /// Note that transactions that got removed from the mempool because they were included in a
    /// block increment Bitcoin Core's mempool sequence, they do not produce a [`MempoolRemoval`].
    ///
    /// [`MempoolAcceptance`]: SequenceMessage::MempoolAcceptance
    /// [`MempoolRemoval`]: SequenceMessage::MempoolRemoval
    pub fn mempool_sequence(&self) -> Option<u64> {
        match self {
            Self::BlockConnect { .. } | Self::BlockDisconnect { .. } => None,
            Self::MempoolAcceptance {
                mempool_sequence, ..
            }
            | Self::MempoolRemoval {
                mempool_sequence, ..
            } => Some(*mempool_sequence),
        }
    }
}

impl TryFrom<Vec<u8>> for SequenceMessage {
    type Error = Error;

    fn try_from(value: Vec<u8>) -> Result<Self> {
        if value.len() < 33 {
            return Err(Error::InvalidSequenceMessageLengthError(value.len()));
        }

        let mut hash: [u8; 32] = value[0..32].try_into().unwrap();
        hash.reverse();

        let label = value[32];
        Ok(match label {
            b'C' | b'D' => {
                if value.len() != 33 {
                    return Err(Error::InvalidSequenceMessageLengthError(value.len()));
                }

                let blockhash = BlockHash::from_byte_array(hash);

                match label {
                    b'C' => Self::BlockConnect { blockhash },
                    _ /* b'D' */ => Self::BlockDisconnect { blockhash },
                }
            }
            b'A' | b'R' => {
                if value.len() != 41 {
                    return Err(Error::InvalidSequenceMessageLengthError(value.len()));
                }

                let txid = Txid::from_byte_array(hash);
                let mempool_sequence = u64::from_le_bytes(value[33..41].try_into().unwrap());

                match label {
                    b'A' => Self::MempoolAcceptance { txid, mempool_sequence },
                    _ /* b'R' */ => Self::MempoolRemoval { txid, mempool_sequence },
                }
            }
            _ => return Err(Error::InvalidSequenceMessageLabelError(label)),
        })
    }
}

impl From<SequenceMessage> for Vec<u8> {
    fn from(sm: SequenceMessage) -> Self {
        let mut ret = Vec::with_capacity(sm.raw_length());

        // blockhash or txid
        ret.extend_from_slice(&sm.into_inner());

        // label
        ret.push(sm.label());

        // optional mempool sequence
        if let Some(mempool_sequence) = sm.mempool_sequence() {
            ret.extend_from_slice(&mempool_sequence.to_le_bytes());
        }

        ret
    }
}

impl fmt::Display for SequenceMessage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SequenceMessage::BlockConnect { blockhash } => write!(f, "BlockConnect({blockhash})"),
            SequenceMessage::BlockDisconnect { blockhash } => {
                write!(f, "BlockDisconnect({blockhash})")
            }
            SequenceMessage::MempoolAcceptance {
                txid,
                mempool_sequence,
            } => write!(
                f,
                "MempoolAcceptance({txid}, mempool_sequence={mempool_sequence})"
            ),
            SequenceMessage::MempoolRemoval {
                txid,
                mempool_sequence,
            } => write!(
                f,
                "MempoolRemoval({txid}, mempool_sequence={mempool_sequence})"
            ),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::SequenceMessage;
    use bitcoin::{constants::genesis_block, Network};

    #[test]
    fn serialization() {
        let genesis_block = genesis_block(Network::Bitcoin);

        let blockhash = genesis_block.block_hash();
        let txid = genesis_block.txdata[0].txid();

        let connect_message = SequenceMessage::BlockConnect { blockhash };
        let connect_bytes: Vec<u8> = connect_message.clone().into();
        assert_eq!(connect_message.raw_length(), connect_bytes.len());
        assert_eq!(connect_message.raw_length(), 32 + 1);
        assert_eq!(connect_message, connect_bytes.try_into().unwrap());

        let disconnect_message = SequenceMessage::BlockDisconnect { blockhash };
        let disconnect_bytes: Vec<u8> = disconnect_message.clone().into();
        assert_eq!(disconnect_message.raw_length(), disconnect_bytes.len());
        assert_eq!(disconnect_message.raw_length(), 32 + 1);
        assert_eq!(disconnect_message, disconnect_bytes.try_into().unwrap());

        let accept_message = SequenceMessage::MempoolAcceptance {
            txid,
            mempool_sequence: 0,
        };
        let accept_bytes: Vec<u8> = accept_message.clone().into();
        assert_eq!(accept_message.raw_length(), accept_bytes.len());
        assert_eq!(accept_message.raw_length(), 32 + 1 + 8);
        assert_eq!(accept_message, accept_bytes.try_into().unwrap());

        let remove_message = SequenceMessage::MempoolRemoval {
            txid,
            mempool_sequence: 1,
        };
        let remove_bytes: Vec<u8> = remove_message.clone().into();
        assert_eq!(remove_message.raw_length(), remove_bytes.len());
        assert_eq!(remove_message.raw_length(), 32 + 1 + 8);
        assert_eq!(remove_message, remove_bytes.try_into().unwrap());
    }
}