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
use massa_models::{
    endorsement::{Endorsement, EndorsementDeserializer, SecureShareEndorsement},
    secure_share::{SecureShareDeserializer, SecureShareSerializer},
};
use massa_serialization::{Deserializer, Serializer, U64VarIntDeserializer, U64VarIntSerializer};
use nom::{
    error::{context, ContextError, ParseError},
    multi::length_count,
    IResult, Parser,
};
use num_enum::{IntoPrimitive, TryFromPrimitive};
use std::ops::Bound::Included;

#[derive(Debug, PartialEq, Eq)]
pub enum EndorsementMessage {
    /// Endorsements
    Endorsements(Vec<SecureShareEndorsement>),
}

#[derive(IntoPrimitive, Debug, Eq, PartialEq, TryFromPrimitive)]
#[repr(u64)]
pub enum MessageTypeId {
    Endorsements,
}

impl From<&EndorsementMessage> for MessageTypeId {
    fn from(message: &EndorsementMessage) -> Self {
        match message {
            EndorsementMessage::Endorsements(_) => MessageTypeId::Endorsements,
        }
    }
}

#[derive(Default, Clone)]
pub struct EndorsementMessageSerializer {
    id_serializer: U64VarIntSerializer,
    length_endorsements_serializer: U64VarIntSerializer,
    secure_share_serializer: SecureShareSerializer,
}

impl EndorsementMessageSerializer {
    pub fn new() -> Self {
        Self {
            id_serializer: U64VarIntSerializer::new(),
            length_endorsements_serializer: U64VarIntSerializer::new(),
            secure_share_serializer: SecureShareSerializer::new(),
        }
    }
}

impl Serializer<EndorsementMessage> for EndorsementMessageSerializer {
    fn serialize(
        &self,
        value: &EndorsementMessage,
        buffer: &mut Vec<u8>,
    ) -> Result<(), massa_serialization::SerializeError> {
        self.id_serializer
            .serialize(&MessageTypeId::from(value).into(), buffer)?;
        match value {
            EndorsementMessage::Endorsements(endorsements) => {
                self.length_endorsements_serializer
                    .serialize(&(endorsements.len() as u64), buffer)?;
                for endorsement in endorsements {
                    self.secure_share_serializer
                        .serialize(endorsement, buffer)?;
                }
            }
        }
        Ok(())
    }
}

pub struct EndorsementMessageDeserializerArgs {
    pub thread_count: u8,
    pub max_length_endorsements: u64,
    pub endorsement_count: u32,
    pub chain_id: u64,
}

pub struct EndorsementMessageDeserializer {
    id_deserializer: U64VarIntDeserializer,
    length_endorsements_deserializer: U64VarIntDeserializer,
    secure_share_deserializer: SecureShareDeserializer<Endorsement, EndorsementDeserializer>,
}

impl EndorsementMessageDeserializer {
    pub fn new(args: EndorsementMessageDeserializerArgs) -> Self {
        Self {
            id_deserializer: U64VarIntDeserializer::new(Included(0), Included(u64::MAX)),
            length_endorsements_deserializer: U64VarIntDeserializer::new(
                Included(0),
                Included(args.max_length_endorsements),
            ),
            secure_share_deserializer: SecureShareDeserializer::new(
                EndorsementDeserializer::new(args.thread_count, args.endorsement_count),
                args.chain_id,
            ),
        }
    }
}

impl Deserializer<EndorsementMessage> for EndorsementMessageDeserializer {
    fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
        &self,
        buffer: &'a [u8],
    ) -> IResult<&'a [u8], EndorsementMessage, E> {
        context("Failed EndorsementMessage deserialization", |buffer| {
            let (buffer, raw_id) = self.id_deserializer.deserialize(buffer)?;
            let id = MessageTypeId::try_from(raw_id).map_err(|_| {
                nom::Err::Error(ParseError::from_error_kind(
                    buffer,
                    nom::error::ErrorKind::Eof,
                ))
            })?;
            match id {
                MessageTypeId::Endorsements => context(
                    "Failed Endorsements deserialization",
                    length_count(
                        context("Failed length deserialization", |input| {
                            self.length_endorsements_deserializer.deserialize(input)
                        }),
                        context("Failed endorsement deserialization", |input| {
                            self.secure_share_deserializer.deserialize(input)
                        }),
                    ),
                )
                .map(EndorsementMessage::Endorsements)
                .parse(buffer),
            }
        })
        .parse(buffer)
    }
}

#[cfg(test)]
mod tests {
    use std::str::FromStr;

    use massa_models::config::CHAINID;
    use massa_models::{
        block_id::BlockId,
        endorsement::{Endorsement, EndorsementSerializer},
        secure_share::SecureShareContent,
        slot::Slot,
    };
    use massa_serialization::{DeserializeError, Deserializer, Serializer};
    use massa_signature::KeyPair;

    #[test]
    fn test_lower_limit_message() {
        let message = super::EndorsementMessage::Endorsements(vec![]);
        let mut buffer = Vec::new();
        let serializer = super::EndorsementMessageSerializer::new();
        serializer
            .serialize(&message, &mut buffer)
            .expect("Failed to serialize message");
        let deserializer =
            super::EndorsementMessageDeserializer::new(super::EndorsementMessageDeserializerArgs {
                thread_count: 1,
                max_length_endorsements: 0,
                endorsement_count: 1,
                chain_id: *CHAINID,
            });
        let (rest, deserialized_message) = deserializer
            .deserialize::<DeserializeError>(&buffer)
            .expect("Failed to deserialize message");
        assert!(rest.is_empty());
        assert_eq!(deserialized_message, message);
    }

    #[test]
    fn test_high_limit_message() {
        let endorsement = Endorsement {
            slot: Slot::new(u64::MAX, 31),
            index: 15,
            endorsed_block: BlockId::from_str(
                "B12DvrcQkzF1Wi8BVoNfc4n93CD3E2qhCNe7nVhnEQGWHZ24fEmg",
            )
            .unwrap(),
        };
        let secure_share_endo = endorsement
            .new_verifiable(
                EndorsementSerializer::new(),
                &KeyPair::generate(0).unwrap(),
                *CHAINID,
            )
            .unwrap();
        let message = super::EndorsementMessage::Endorsements(vec![
            secure_share_endo.clone(),
            secure_share_endo.clone(),
        ]);
        let mut buffer = Vec::new();
        let serializer = super::EndorsementMessageSerializer::new();
        serializer
            .serialize(&message, &mut buffer)
            .expect("Failed to serialize message");
        let deserializer =
            super::EndorsementMessageDeserializer::new(super::EndorsementMessageDeserializerArgs {
                thread_count: 32,
                max_length_endorsements: 1,
                endorsement_count: 16,
                chain_id: *CHAINID,
            });
        deserializer
            .deserialize::<DeserializeError>(&buffer)
            .expect_err("Should fail because there is two element and the limit is one");
        let message2 = super::EndorsementMessage::Endorsements(vec![secure_share_endo.clone()]);
        let mut buffer2 = Vec::new();
        serializer
            .serialize(&message2, &mut buffer2)
            .expect("Failed to serialize message");
        let (rest, deserialized_message) = deserializer
            .deserialize::<DeserializeError>(&buffer2)
            .expect("Failed to deserialize message");
        assert!(rest.is_empty());
        assert_eq!(deserialized_message, message2);
    }
}