Add documentation to public structs/functions in sc_tendermint

This commit is contained in:
Luke Parker
2022-10-30 12:27:16 -04:00
parent c4976ff97d
commit 8f065533dc
5 changed files with 12 additions and 0 deletions

View File

@@ -62,12 +62,14 @@ struct ActiveAuthority<T: TendermintValidator> {
announce: T::Network,
}
/// Tendermint Authority. Participates in the block proposal and voting process.
pub struct TendermintAuthority<T: TendermintValidator> {
import: TendermintImport<T>,
active: Option<ActiveAuthority<T>>,
}
impl<T: TendermintValidator> TendermintAuthority<T> {
/// Create a new TendermintAuthority.
pub fn new(import: TendermintImport<T>) -> Self {
Self { import, active: None }
}