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

//! Defines the trait to be implemented by all concrete consensus state types

use core::marker::{Send, Sync};

use ibc_core_commitment_types::commitment::CommitmentRoot;
/// Derive macro that implements [`ConsensusState`] for enums containing
/// variants that implement [`ConsensusState`]
pub use ibc_derive::ConsensusState;
use ibc_primitives::prelude::*;
use ibc_primitives::Timestamp;

/// Defines methods that all `ConsensusState`s should provide.
///
/// One can think of a "consensus state" as a pruned header, to be stored on chain. In other words,
/// a consensus state only contains the header's information needed by IBC message handlers.
pub trait ConsensusState: Send + Sync {
    /// Commitment root of the consensus state, which is used for key-value pair verification.
    fn root(&self) -> &CommitmentRoot;

    /// The timestamp of the consensus state
    fn timestamp(&self) -> Timestamp;

    /// Serializes the `ConsensusState`. This is expected to be implemented as
    /// first converting to the raw type (i.e. the protobuf definition), and then
    /// serializing that.
    fn encode_vec(self) -> Vec<u8>;
}