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 <[email protected]> Co-authored-by: Rano | Ranadeep <[email protected]>
cosmos · Jun 17, 2024 · 8424f69 · 8424f69
1 parent 588f7eb
commit 8424f69
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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 {