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

//! Commits to a Tendermint blockchain

use serde::{Deserialize, Serialize};
use tendermint_proto::v0_37::types::Commit as RawCommit;

use crate::{
    block::{commit_sig::CommitSig, Height, Id, Round},
    prelude::*,
};

/// Commit contains the justification (ie. a set of signatures) that a block was committed by a set
/// of validators.
/// TODO: Update links below!
/// <https://github.com/tendermint/tendermint/blob/51dc810d041eaac78320adc6d53ad8b160b06601/types/block.go#L486-L502>
/// <https://github.com/tendermint/spec/blob/d46cd7f573a2c6a2399fcab2cde981330aa63f37/spec/core/data_structures.md#lastcommit>
#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize)]
#[serde(try_from = "RawCommit", into = "RawCommit")] // Used by testgen Generator trait
pub struct Commit {
    /// Block height
    pub height: Height,

    /// Round
    pub round: Round,

    /// Block ID
    pub block_id: Id,

    /// Signatures
    pub signatures: Vec<CommitSig>,
}

tendermint_pb_modules! {
    use super::Commit;
    use crate::{
        block::commit_sig::CommitSig,
        error::Error,
        prelude::*,
    };
    use pb::types::Commit as RawCommit;

    impl TryFrom<RawCommit> for Commit {
        type Error = Error;

        fn try_from(value: RawCommit) -> Result<Self, Self::Error> {
            let signatures: Result<Vec<CommitSig>, Error> = value
                .signatures
                .into_iter()
                .map(TryFrom::try_from)
                .collect();
            Ok(Self {
                height: value.height.try_into()?,
                round: value.round.try_into()?,
                block_id: value
                    .block_id
                    .ok_or_else(|| Error::invalid_block("missing block id".to_string()))?
                    .try_into()?, // gogoproto.nullable = false
                signatures: signatures?,
            })
        }
    }

    impl From<Commit> for RawCommit {
        fn from(value: Commit) -> Self {
            RawCommit {
                height: value.height.into(),
                round: value.round.into(),
                block_id: Some(value.block_id.into()),
                signatures: value.signatures.into_iter().map(Into::into).collect(),
            }
        }
    }
}

impl Default for Commit {
    fn default() -> Self {
        Commit {
            // The default Height is 1, but the default commit is an empty commit with height = 0.
            height: Height::from(0_u32),
            round: Default::default(),
            block_id: Default::default(),
            signatures: vec![],
        }
    }
}