From d9f5c9e9ece364875d302246cc522bf6a810c704 Mon Sep 17 00:00:00 2001 From: Ranadeep Biswas Date: Tue, 30 Apr 2024 22:24:38 +0200 Subject: [PATCH] update comment --- docs/architecture/adr-009-revamp-testkit.md | 7 ++++--- ibc-testkit/src/hosts/mod.rs | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/architecture/adr-009-revamp-testkit.md b/docs/architecture/adr-009-revamp-testkit.md index 24be678ae..439b26173 100644 --- a/docs/architecture/adr-009-revamp-testkit.md +++ b/docs/architecture/adr-009-revamp-testkit.md @@ -35,8 +35,8 @@ To achieve this, we have broken down the proposal into sub-proposals: The current framework uses `HashMap` and `HashSet` to store data. This works for many test scenarios, but it fails to test proof-sensitive scenarios. Because of -this, we don't have any connection, channel handshake, or packet relay tests that -cover the Tendermint light client. +this, we don't have any connection, channel handshake, or packet relay tests +that cover the Tendermint light client. We generalize [`MockContext`](https://github.com/cosmos/ibc-rs/blob/v0.51.0/ibc-testkit/src/testapp/ibc/core/types.rs#L103) @@ -123,7 +123,8 @@ pub trait TestBlock: Clone + Debug { fn into_header(self) -> Self::Header; } -/// TestHeader is a trait that defines the interface for a header produced by a host blockchain. +/// TestHeader is a trait that defines the interface for a header +/// submitted by relayer from the host blockchain. pub trait TestHeader: Clone + Debug + Into { /// The type of consensus state can be extracted from the header. type ConsensusState: ConsensusState + Into + From + Clone + Debug; diff --git a/ibc-testkit/src/hosts/mod.rs b/ibc-testkit/src/hosts/mod.rs index 3a4183401..426b69066 100644 --- a/ibc-testkit/src/hosts/mod.rs +++ b/ibc-testkit/src/hosts/mod.rs @@ -138,7 +138,8 @@ pub trait TestBlock: Clone + Debug { } } -/// TestHeader is a trait that defines the interface for a header corresponding to a host blockchain. +/// TestHeader is a trait that defines the interface for a header +/// submitted by relayer from the host blockchain. pub trait TestHeader: Clone + Debug + Into { /// The type of consensus state can be extracted from the header. type ConsensusState: ConsensusState + Into + From + Clone + Debug;