ibc_testkit/hosts/
tendermint.rs

use core::str::FromStr;

use bon::Builder;
use ibc::clients::tendermint::client_state::ClientState;
use ibc::clients::tendermint::consensus_state::ConsensusState;
use ibc::clients::tendermint::types::proto::v1::Header as RawHeader;
use ibc::clients::tendermint::types::{Header, TENDERMINT_HEADER_TYPE_URL};
use ibc::core::client::types::Height;
use ibc::core::host::types::identifiers::ChainId;
use ibc::core::primitives::prelude::*;
use ibc::core::primitives::Timestamp;
use ibc::primitives::proto::Any;
use ibc::primitives::{IntoHostTime, IntoTimestamp, ToVec};
use tendermint::block::Header as TmHeader;
use tendermint::validator::Set as ValidatorSet;
use tendermint_testgen::light_block::TmLightBlock;
use tendermint_testgen::{
    Generator, Header as TestgenHeader, LightBlock as TestgenLightBlock,
    Validator as TestgenValidator,
};

use crate::fixtures::clients::tendermint::ClientStateConfig;
use crate::hosts::{TestBlock, TestHeader, TestHost};

/// A host that produces Tendermint blocks and interfaces with Tendermint light clients.
#[derive(Debug, Builder)]
pub struct TendermintHost {
    /// Unique identifier for the chain.
    #[builder(default = ChainId::new("mock-0").expect("Never fails"))]
    pub chain_id: ChainId,
    /// The chain of blocks underlying this context.
    #[builder(default)]
    pub history: Vec<TmLightBlock>,
}

impl Default for TendermintHost {
    fn default() -> Self {
        Self::builder().build()
    }
}

impl TestHost for TendermintHost {
    type Block = TmLightBlock;
    type BlockParams = BlockParams;
    type LightClientParams = ClientStateConfig;
    type ClientState = ClientState;

    fn history(&self) -> &Vec<Self::Block> {
        &self.history
    }

    fn push_block(&mut self, block: Self::Block) {
        self.history.push(block);
    }

    fn generate_block(
        &self,
        commitment_root: Vec<u8>,
        height: u64,
        timestamp: Timestamp,
        params: &Self::BlockParams,
    ) -> Self::Block {
        TestgenLightBlock::new_default_with_header(
            TestgenHeader::new(&params.validators)
                .app_hash(commitment_root.try_into().expect("infallible"))
                .height(height)
                .chain_id(self.chain_id.as_str())
                .next_validators(&params.next_validators)
                .time(timestamp.into_host_time().expect("Never fails")),
        )
        .validators(&params.validators)
        .next_validators(&params.next_validators)
        .generate()
        .expect("Never fails")
    }

    fn generate_client_state(
        &self,
        latest_height: &Height,
        params: &Self::LightClientParams,
    ) -> Self::ClientState {
        let client_state = ClientStateConfig::builder()
            .trusting_period(params.trusting_period)
            .max_clock_drift(params.max_clock_drift)
            .unbonding_period(params.unbonding_period)
            .proof_specs(params.proof_specs.clone())
            .build()
            .into_client_state(
                self.chain_id.clone(),
                self.get_block(latest_height)
                    .expect("block exists")
                    .height(),
            )
            .expect("never fails");

        client_state.inner().validate().expect("never fails");

        client_state
    }
}

impl TestBlock for TmLightBlock {
    type Header = TendermintHeader;

    fn height(&self) -> Height {
        Height::new(
            ChainId::from_str(self.signed_header.header.chain_id.as_str())
                .expect("Never fails")
                .revision_number(),
            self.signed_header.header.height.value(),
        )
        .expect("Never fails")
    }

    fn timestamp(&self) -> Timestamp {
        self.signed_header
            .header
            .time
            .into_timestamp()
            .expect("Never fails")
    }

    fn into_header_with_trusted(self, trusted_block: &Self) -> Self::Header {
        let mut header = TendermintHeader::from(self.clone());
        header.set_trusted_height(trusted_block.height());
        header.set_trusted_next_validators_set(trusted_block.validators.clone());
        header
    }
}

#[derive(Debug, Builder)]
pub struct BlockParams {
    pub validators: Vec<TestgenValidator>,
    pub next_validators: Vec<TestgenValidator>,
}

impl BlockParams {
    pub fn from_validator_history(validator_history: Vec<Vec<TestgenValidator>>) -> Vec<Self> {
        validator_history
            .windows(2)
            .map(|vals| {
                Self::builder()
                    .validators(vals[0].clone())
                    .next_validators(vals[1].clone())
                    .build()
            })
            .collect()
    }
}

impl Default for BlockParams {
    fn default() -> Self {
        Self::builder()
            .validators(vec![
                TestgenValidator::new("1").voting_power(50),
                TestgenValidator::new("2").voting_power(50),
            ])
            .next_validators(vec![
                TestgenValidator::new("1").voting_power(50),
                TestgenValidator::new("2").voting_power(50),
            ])
            .build()
    }
}

/// This wrapper type is needed to implement
/// [`From`] traits [`Header`] to foreign types.
#[derive(Debug, Clone)]
pub struct TendermintHeader(Header);

impl TendermintHeader {
    pub fn set_trusted_height(&mut self, trusted_height: Height) {
        self.0.trusted_height = trusted_height
    }

    pub fn set_trusted_next_validators_set(&mut self, trusted_next_validator_set: ValidatorSet) {
        self.0.trusted_next_validator_set = trusted_next_validator_set
    }

    pub fn header(&self) -> &TmHeader {
        &self.0.signed_header.header
    }
}

impl TestHeader for TendermintHeader {
    type ConsensusState = ConsensusState;

    fn height(&self) -> Height {
        Height::new(
            ChainId::from_str(self.0.signed_header.header.chain_id.as_str())
                .expect("Never fails")
                .revision_number(),
            self.0.signed_header.header.height.value(),
        )
        .expect("Never fails")
    }

    fn timestamp(&self) -> Timestamp {
        self.0
            .signed_header
            .header
            .time
            .into_timestamp()
            .expect("Never fails")
    }
}

impl From<TendermintHeader> for Header {
    fn from(header: TendermintHeader) -> Self {
        header.0
    }
}

impl From<TendermintHeader> for ConsensusState {
    fn from(header: TendermintHeader) -> Self {
        header.0.signed_header.header.into()
    }
}

impl From<TmLightBlock> for TendermintHeader {
    fn from(block: TmLightBlock) -> Self {
        let trusted_height = block.height();

        let TmLightBlock {
            signed_header,
            validators: validator_set,
            ..
        } = block;

        let trusted_next_validator_set = validator_set.clone();

        // by default trust the current height and validators
        Self(Header {
            signed_header,
            validator_set,
            trusted_height,
            trusted_next_validator_set,
        })
    }
}

impl From<TendermintHeader> for Any {
    fn from(value: TendermintHeader) -> Self {
        Self {
            type_url: TENDERMINT_HEADER_TYPE_URL.to_string(),
            value: RawHeader::from(value.0).to_vec(),
        }
    }
}
ibc_testkit/hosts/tendermint.rs

ibc_testkit/hosts/
tendermint.rs
