From 8424f6903045b203614f12a5839c330a3559cece Mon Sep 17 00:00:00 2001 From: Sean Chen Date: Mon, 17 Jun 2024 14:03:35 -0500 Subject: [PATCH] Remove `pub` from `MockConsensusState::root` field (#1259) * Remove `pub` from root field * Add incomplete comment to `MockConsensusState` * Comment formatting * Address rust 1.79 clippy error * Improve MockConsensusState doc comment * ignore dotenv file * add doc links in doc comment --------- Co-authored-by: Ranadeep Biswas Co-authored-by: Rano | Ranadeep --- .gitignore | 3 +++ ibc-core/ics03-connection/types/src/connection.rs | 1 - .../src/testapp/ibc/clients/mock/consensus_state.rs | 8 +++++++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 42f1212d9..341707b20 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,6 @@ mc.log # Ignore CosmWasm artifacts /cw-contracts + +# Ignore dotenv +.env diff --git a/ibc-core/ics03-connection/types/src/connection.rs b/ibc-core/ics03-connection/types/src/connection.rs index 1a6499193..227632161 100644 --- a/ibc-core/ics03-connection/types/src/connection.rs +++ b/ibc-core/ics03-connection/types/src/connection.rs @@ -2,7 +2,6 @@ use core::fmt::{Display, Error as FmtError, Formatter}; use core::time::Duration; -use core::u64; use ibc_core_client_types::error::ClientError; use ibc_core_commitment_types::commitment::CommitmentPrefix; diff --git a/ibc-testkit/src/testapp/ibc/clients/mock/consensus_state.rs b/ibc-testkit/src/testapp/ibc/clients/mock/consensus_state.rs index c637d26e5..82536d2d6 100644 --- a/ibc-testkit/src/testapp/ibc/clients/mock/consensus_state.rs +++ b/ibc-testkit/src/testapp/ibc/clients/mock/consensus_state.rs @@ -9,11 +9,17 @@ use crate::testapp::ibc::clients::mock::header::MockHeader; use crate::testapp::ibc::clients::mock::proto::ConsensusState as RawMockConsensusState; pub const MOCK_CONSENSUS_STATE_TYPE_URL: &str = "/ibc.mock.ConsensusState"; +/// The mock consensus state type used within ibc-testkit for testing situations +/// when a consensus state is required. +/// +/// Note, this type slightly differs from the [`RawMockConsensusState`] type exposed by +/// ibc-proto. It contains a (private) `root` field to easily return a +/// reference to the mock consensus state's dummy [`CommitmentRoot`]. #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] #[derive(Clone, Debug, PartialEq, Eq)] pub struct MockConsensusState { pub header: MockHeader, - pub root: CommitmentRoot, + root: CommitmentRoot, } impl MockConsensusState {