tendermint/
proposal.rs

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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
//! Proposals from validators

mod canonical_proposal;
mod msg_type;
mod sign_proposal;

use bytes::BufMut;
pub use msg_type::Type;
pub use sign_proposal::{SignProposalRequest, SignedProposalResponse};
use tendermint_proto::v0_37::types::CanonicalProposal as RawCanonicalProposal;
use tendermint_proto::{Error as ProtobufError, Protobuf};

pub use self::canonical_proposal::CanonicalProposal;
use crate::{
    block::{Height, Id as BlockId, Round},
    chain::Id as ChainId,
    consensus::State,
    prelude::*,
    Signature, Time,
};

/// Proposal
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Proposal {
    /// Proposal message type
    pub msg_type: Type,
    /// Height
    pub height: Height,
    /// Round
    pub round: Round,
    /// POL Round
    pub pol_round: Option<Round>,
    /// Block ID
    pub block_id: Option<BlockId>,
    /// Timestamp
    pub timestamp: Option<Time>,
    /// Signature
    pub signature: Option<Signature>,
}

tendermint_pb_modules! {
    use super::Proposal;
    use crate::{Signature, Error, block::Round};
    use pb::types::Proposal as RawProposal;

    impl Protobuf<RawProposal> for Proposal {}

    impl TryFrom<RawProposal> for Proposal {
        type Error = Error;

        fn try_from(value: RawProposal) -> Result<Self, Self::Error> {
            if value.pol_round < -1 {
                return Err(Error::negative_pol_round());
            }
            let pol_round = match value.pol_round {
                -1 => None,
                n => Some(Round::try_from(n)?),
            };
            Ok(Proposal {
                msg_type: value.r#type.try_into()?,
                height: value.height.try_into()?,
                round: value.round.try_into()?,
                pol_round,
                block_id: value.block_id.map(TryInto::try_into).transpose()?,
                timestamp: value.timestamp.map(|t| t.try_into()).transpose()?,
                signature: Signature::new(value.signature)?,
            })
        }
    }

    impl From<Proposal> for RawProposal {
        fn from(value: Proposal) -> Self {
            RawProposal {
                r#type: value.msg_type.into(),
                height: value.height.into(),
                round: value.round.into(),
                pol_round: value.pol_round.map_or(-1, Into::into),
                block_id: value.block_id.map(Into::into),
                timestamp: value.timestamp.map(Into::into),
                signature: value.signature.map(|s| s.into_bytes()).unwrap_or_default(),
            }
        }
    }
}

impl Proposal {
    /// Create signable bytes from Proposal.
    pub fn to_signable_bytes<B>(
        &self,
        chain_id: ChainId,
        sign_bytes: &mut B,
    ) -> Result<bool, ProtobufError>
    where
        B: BufMut,
    {
        let canonical = CanonicalProposal::new(self.clone(), chain_id);
        Protobuf::<RawCanonicalProposal>::encode_length_delimited(canonical, sign_bytes)?;
        Ok(true)
    }

    /// Create signable vector from Proposal.
    pub fn into_signable_vec(self, chain_id: ChainId) -> Vec<u8> {
        let canonical = CanonicalProposal::new(self, chain_id);
        Protobuf::<RawCanonicalProposal>::encode_length_delimited_vec(canonical)
    }

    /// Consensus state from this proposal - This doesn't seem to be used anywhere.
    #[deprecated(
        since = "0.17.0",
        note = "This seems unnecessary, please raise it to the team, if you need it."
    )]
    pub fn consensus_state(&self) -> State {
        State {
            height: self.height,
            round: self.round,
            step: 3,
            block_id: self.block_id,
        }
    }
}

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

    use time::macros::datetime;

    use crate::{
        block::{parts::Header, Height, Id as BlockId, Round},
        chain::Id as ChainId,
        hash::{Algorithm, Hash},
        prelude::*,
        proposal::{SignProposalRequest, Type},
        test::dummy_signature,
        Proposal,
    };

    #[test]
    fn test_serialization() {
        let dt = datetime!(2018-02-11 07:09:22.765 UTC);
        let proposal = Proposal {
            msg_type: Type::Proposal,
            height: Height::from(12345_u32),
            round: Round::from(23456_u16),
            pol_round: None,
            block_id: Some(BlockId {
                hash: Hash::from_hex_upper(
                    Algorithm::Sha256,
                    "DEADBEEFDEADBEEFBAFBAFBAFBAFBAFADEADBEEFDEADBEEFBAFBAFBAFBAFBAFA",
                )
                .unwrap(),
                part_set_header: Header::new(
                    65535,
                    Hash::from_hex_upper(
                        Algorithm::Sha256,
                        "0022446688AACCEE1133557799BBDDFF0022446688AACCEE1133557799BBDDFF",
                    )
                    .unwrap(),
                )
                .unwrap(),
            }),
            timestamp: Some(dt.try_into().unwrap()),
            signature: Some(dummy_signature()),
        };

        let mut got = vec![];

        let request = SignProposalRequest {
            proposal,
            chain_id: ChainId::from_str("test_chain_id").unwrap(),
        };

        let _have = request.to_signable_bytes(&mut got);

        // the following vector is generated via:
        // import (
        // "encoding/hex"
        // "fmt"
        // prototypes "github.com/tendermint/tendermint/proto/tendermint/types"
        // "github.com/tendermint/tendermint/types"
        // "strings"
        // "time"
        // )
        //
        // func proposalSerialize() {
        // stamp, _ := time.Parse(time.RFC3339Nano, "2018-02-11T07:09:22.765Z")
        // block_hash, _ :=
        // hex.DecodeString("DEADBEEFDEADBEEFBAFBAFBAFBAFBAFADEADBEEFDEADBEEFBAFBAFBAFBAFBAFA")
        // part_hash, _ :=
        // hex.DecodeString("0022446688AACCEE1133557799BBDDFF0022446688AACCEE1133557799BBDDFF")
        // proposal := &types.Proposal{
        // Type:     prototypes.SignedMsgType(prototypes.ProposalType),
        // Height:   12345,
        // Round:    23456,
        // POLRound: -1,
        // BlockID: types.BlockID{
        // Hash: block_hash,
        // PartSetHeader: types.PartSetHeader{
        // Hash:  part_hash,
        // Total: 65535,
        // },
        // },
        // Timestamp: stamp,
        // }
        // signBytes := types.ProposalSignBytes("test_chain_id", proposal.ToProto())
        // fmt.Println(strings.Join(strings.Split(fmt.Sprintf("%v", signBytes), " "), ", "))
        // }

        let want = vec![
            136, 1, 8, 32, 17, 57, 48, 0, 0, 0, 0, 0, 0, 25, 160, 91, 0, 0, 0, 0, 0, 0, 32, 255,
            255, 255, 255, 255, 255, 255, 255, 255, 1, 42, 74, 10, 32, 222, 173, 190, 239, 222,
            173, 190, 239, 186, 251, 175, 186, 251, 175, 186, 250, 222, 173, 190, 239, 222, 173,
            190, 239, 186, 251, 175, 186, 251, 175, 186, 250, 18, 38, 8, 255, 255, 3, 18, 32, 0,
            34, 68, 102, 136, 170, 204, 238, 17, 51, 85, 119, 153, 187, 221, 255, 0, 34, 68, 102,
            136, 170, 204, 238, 17, 51, 85, 119, 153, 187, 221, 255, 50, 12, 8, 162, 216, 255, 211,
            5, 16, 192, 242, 227, 236, 2, 58, 13, 116, 101, 115, 116, 95, 99, 104, 97, 105, 110,
            95, 105, 100,
        ];

        assert_eq!(got, want)
    }

    #[test]
    // Test proposal encoding with a malformed block ID which is considered null in Go.
    fn test_encoding_with_empty_block_id() {
        let dt = datetime!(2018-02-11 07:09:22.765 UTC);
        let proposal = Proposal {
            msg_type: Type::Proposal,
            height: Height::from(12345_u32),
            round: Round::from(23456_u16),
            pol_round: None,
            block_id: Some(BlockId {
                hash: Hash::from_hex_upper(Algorithm::Sha256, "").unwrap(),
                part_set_header: Header::new(
                    65535,
                    Hash::from_hex_upper(
                        Algorithm::Sha256,
                        "0022446688AACCEE1133557799BBDDFF0022446688AACCEE1133557799BBDDFF",
                    )
                    .unwrap(),
                )
                .unwrap(),
            }),
            timestamp: Some(dt.try_into().unwrap()),
            signature: Some(dummy_signature()),
        };

        let mut got = vec![];

        let request = SignProposalRequest {
            proposal,
            chain_id: ChainId::from_str("test_chain_id").unwrap(),
        };

        let _have = request.to_signable_bytes(&mut got);

        // the following vector is generated via:
        // import (
        // "encoding/hex"
        // "fmt"
        // prototypes "github.com/tendermint/tendermint/proto/tendermint/types"
        // "github.com/tendermint/tendermint/types"
        // "strings"
        // "time"
        // )
        //
        // func proposalSerialize() {
        // stamp, _ := time.Parse(time.RFC3339Nano, "2018-02-11T07:09:22.765Z")
        // block_hash, _ := hex.DecodeString("")
        // part_hash, _ :=
        // hex.DecodeString("0022446688AACCEE1133557799BBDDFF0022446688AACCEE1133557799BBDDFF")
        // proposal := &types.Proposal{
        // Type:     prototypes.SignedMsgType(prototypes.ProposalType),
        // Height:   12345,
        // Round:    23456,
        // POLRound: -1,
        // BlockID: types.BlockID{
        // Hash: block_hash,
        // PartSetHeader: types.PartSetHeader{
        // Hash:  part_hash,
        // Total: 65535,
        // },
        // },
        // Timestamp: stamp,
        // }
        // signBytes := types.ProposalSignBytes("test_chain_id", proposal.ToProto())
        // fmt.Println(strings.Join(strings.Split(fmt.Sprintf("%v", signBytes), " "), ", "))
        // }

        let want = vec![
            102, 8, 32, 17, 57, 48, 0, 0, 0, 0, 0, 0, 25, 160, 91, 0, 0, 0, 0, 0, 0, 32, 255, 255,
            255, 255, 255, 255, 255, 255, 255, 1, 42, 40, 18, 38, 8, 255, 255, 3, 18, 32, 0, 34,
            68, 102, 136, 170, 204, 238, 17, 51, 85, 119, 153, 187, 221, 255, 0, 34, 68, 102, 136,
            170, 204, 238, 17, 51, 85, 119, 153, 187, 221, 255, 50, 12, 8, 162, 216, 255, 211, 5,
            16, 192, 242, 227, 236, 2, 58, 13, 116, 101, 115, 116, 95, 99, 104, 97, 105, 110, 95,
            105, 100,
        ];

        assert_eq!(got, want)
    }

    tendermint_pb_modules! {
        use super::*;

        #[test]
        fn test_deserialization() {
            let dt = datetime!(2018-02-11 07:09:22.765 UTC);
            let proposal = Proposal {
                msg_type: Type::Proposal,
                height: Height::from(12345_u32),
                round: Round::from(23456_u16),
                timestamp: Some(dt.try_into().unwrap()),

                pol_round: None,
                block_id: Some(BlockId {
                    hash: Hash::from_hex_upper(
                        Algorithm::Sha256,
                        "DEADBEEFDEADBEEFBAFBAFBAFBAFBAFADEADBEEFDEADBEEFBAFBAFBAFBAFBAFA",
                    )
                    .unwrap(),
                    part_set_header: Header::new(
                        65535,
                        Hash::from_hex_upper(
                            Algorithm::Sha256,
                            "0022446688AACCEE1133557799BBDDFF0022446688AACCEE1133557799BBDDFF",
                        )
                        .unwrap(),
                    )
                    .unwrap(),
                }),
                signature: Some(dummy_signature()),
            };
            let want = SignProposalRequest {
                proposal,
                chain_id: ChainId::from_str("test_chain_id").unwrap(),
            };

            let data = vec![
                10, 176, 1, 8, 32, 16, 185, 96, 24, 160, 183, 1, 32, 255, 255, 255, 255, 255, 255, 255,
                255, 255, 1, 42, 74, 10, 32, 222, 173, 190, 239, 222, 173, 190, 239, 186, 251, 175,
                186, 251, 175, 186, 250, 222, 173, 190, 239, 222, 173, 190, 239, 186, 251, 175, 186,
                251, 175, 186, 250, 18, 38, 8, 255, 255, 3, 18, 32, 0, 34, 68, 102, 136, 170, 204, 238,
                17, 51, 85, 119, 153, 187, 221, 255, 0, 34, 68, 102, 136, 170, 204, 238, 17, 51, 85,
                119, 153, 187, 221, 255, 50, 12, 8, 162, 216, 255, 211, 5, 16, 192, 242, 227, 236, 2,
                58, 64, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 18, 13, 116, 101, 115, 116, 95, 99, 104, 97, 105, 110, 95,
                105, 100,
            ];

            let have = <SignProposalRequest as Protobuf<pb::privval::SignProposalRequest>>::decode_vec(&data).unwrap();
            assert_eq!(have, want);
        }
    }
}