generalize MockIbcStore

Author: rnbguy

ibc-testkit/src/context.rs

@@ -40,7 +40,7 @@ where
     H: TestHost,
     AnyClientState: From<HostClientState<H>>,
     AnyConsensusState: From<HostConsensusState<H>>,
-    HostClientState<H>: ClientStateValidation<MockIbcStore<S>>,
+    HostClientState<H>: ClientStateValidation<MockIbcStore<S, AnyClientState, AnyConsensusState>>,
 {
     /// The multi store of the context.
     /// This is where the IBC store root is stored at IBC commitment prefix.
@@ -50,7 +50,7 @@ where
     pub host: H,
 
     /// An object that stores all IBC related data.
-    pub ibc_store: MockIbcStore<S>,
+    pub ibc_store: MockIbcStore<S, AnyClientState, AnyConsensusState>,
 
     /// A router that can route messages to the appropriate IBC application.
     pub ibc_router: MockRouter,
@@ -74,7 +74,7 @@ where
     H: TestHost,
     AnyClientState: From<HostClientState<H>>,
     AnyConsensusState: From<HostConsensusState<H>>,
-    HostClientState<H>: ClientStateValidation<MockIbcStore<S>>,
+    HostClientState<H>: ClientStateValidation<MockIbcStore<S, AnyClientState, AnyConsensusState>>,
 {
     fn default() -> Self {
         TestContextConfig::builder().build()
@@ -87,17 +87,17 @@ impl<S, H> StoreGenericTestContext<S, H>
 where
     S: ProvableStore + Debug,
     H: TestHost,
-    HostClientState<H>: ClientStateValidation<MockIbcStore<S>>,
+    HostClientState<H>: ClientStateValidation<MockIbcStore<S, AnyClientState, AnyConsensusState>>,
     AnyClientState: From<HostClientState<H>>,
     AnyConsensusState: From<HostConsensusState<H>>,
 {
     /// Returns an immutable reference to the IBC store.
-    pub fn ibc_store(&self) -> &MockIbcStore<S> {
+    pub fn ibc_store(&self) -> &MockIbcStore<S, AnyClientState, AnyConsensusState> {
         &self.ibc_store
     }
 
     /// Returns a mutable reference to the IBC store.
-    pub fn ibc_store_mut(&mut self) -> &mut MockIbcStore<S> {
+    pub fn ibc_store_mut(&mut self) -> &mut MockIbcStore<S, AnyClientState, AnyConsensusState> {
         &mut self.ibc_store
     }
 

ibc-testkit/src/fixtures/core/context.rs

@@ -44,7 +44,7 @@ where
     H: TestHost,
     AnyClientState: From<HostClientState<H>>,
     AnyConsensusState: From<HostConsensusState<H>>,
-    HostClientState<H>: ClientStateValidation<MockIbcStore<S>>,
+    HostClientState<H>: ClientStateValidation<MockIbcStore<S, AnyClientState, AnyConsensusState>>,
 {
     fn from(params: TestContextConfig<H>) -> Self {
         assert_ne!(

ibc-testkit/src/testapp/ibc/clients/mod.rs

@@ -24,9 +24,11 @@ use crate::testapp::ibc::clients::mock::consensus_state::{
     MockConsensusState, MOCK_CONSENSUS_STATE_TYPE_URL,
 };
 
+type AnyMockIbcStore<S> = MockIbcStore<S, AnyClientState, AnyConsensusState>;
+
 #[derive(Debug, Clone, From, PartialEq, ClientState)]
-#[validation(MockIbcStore<S: ProvableStore + Debug>)]
-#[execution(MockIbcStore<S: ProvableStore + Debug>)]
+#[validation(AnyMockIbcStore<S: ProvableStore + Debug>)]
+#[execution(AnyMockIbcStore<S: ProvableStore + Debug>)]
 pub enum AnyClientState {
     Tendermint(TmClientState),
     Mock(MockClientState),

ibc-testkit/src/testapp/ibc/core/client_ctx.rs

@@ -2,6 +2,8 @@ use core::fmt::Debug;
 
 use basecoin_store::context::{ProvableStore, Store};
 use basecoin_store::types::Height as StoreHeight;
+use ibc::core::client::context::client_state::{ClientStateExecution, ClientStateValidation};
+use ibc::core::client::context::consensus_state::ConsensusState;
 use ibc::core::client::context::{
     ClientExecutionContext, ClientValidationContext, ExtClientValidationContext,
 };
@@ -18,24 +20,25 @@ use ibc::primitives::prelude::*;
 
 use super::types::MockIbcStore;
 use crate::testapp::ibc::clients::mock::client_state::MockClientContext;
-use crate::testapp::ibc::clients::{AnyClientState, AnyConsensusState};
 
 pub type PortChannelIdMap<V> = BTreeMap<PortId, BTreeMap<ChannelId, V>>;
 
 /// A mock of an IBC client record as it is stored in a mock context.
 /// For testing ICS02 handlers mostly, cf. `MockClientContext`.
 #[derive(Clone, Debug)]
-pub struct MockClientRecord {
+pub struct MockClientRecord<ACL, ACS> {
     /// The client state (representing only the latest height at the moment).
-    pub client_state: Option<AnyClientState>,
+    pub client_state: Option<ACL>,
 
     /// Mapping of heights to consensus states for this client.
-    pub consensus_states: BTreeMap<Height, AnyConsensusState>,
+    pub consensus_states: BTreeMap<Height, ACS>,
 }
 
-impl<S> MockClientContext for MockIbcStore<S>
+impl<S, ACL, ACS> MockClientContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     fn host_timestamp(&self) -> Result<Timestamp, ContextError> {
         ValidationContext::host_timestamp(self)
@@ -46,9 +49,11 @@ where
     }
 }
 
-impl<S> ExtClientValidationContext for MockIbcStore<S>
+impl<S, ACL, ACS> ExtClientValidationContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     fn host_timestamp(&self) -> Result<Timestamp, ContextError> {
         ValidationContext::host_timestamp(self)
@@ -152,12 +157,14 @@ where
     }
 }
 
-impl<S> ClientValidationContext for MockIbcStore<S>
+impl<S, ACL, ACS> ClientValidationContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
-    type ClientStateRef = AnyClientState;
-    type ConsensusStateRef = AnyConsensusState;
+    type ClientStateRef = ACL;
+    type ConsensusStateRef = ACS;
 
     fn client_state(&self, client_id: &ClientId) -> Result<Self::ClientStateRef, ContextError> {
         Ok(self
@@ -171,7 +178,7 @@ where
     fn consensus_state(
         &self,
         client_cons_state_path: &ClientConsensusStatePath,
-    ) -> Result<AnyConsensusState, ContextError> {
+    ) -> Result<ACS, ContextError> {
         let height = Height::new(
             client_cons_state_path.revision_number,
             client_cons_state_path.revision_height,
@@ -224,11 +231,13 @@ where
     }
 }
 
-impl<S> ClientExecutionContext for MockIbcStore<S>
+impl<S, ACL, ACS> ClientExecutionContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateExecution<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
-    type ClientStateMut = AnyClientState;
+    type ClientStateMut = ACL;
 
     /// Called upon successful client creation and update
     fn store_client_state(

ibc-testkit/src/testapp/ibc/core/core_ctx.rs

@@ -9,6 +9,7 @@ use ibc::core::channel::types::channel::{ChannelEnd, IdentifiedChannelEnd};
 use ibc::core::channel::types::commitment::{AcknowledgementCommitment, PacketCommitment};
 use ibc::core::channel::types::error::{ChannelError, PacketError};
 use ibc::core::channel::types::packet::{PacketState, Receipt};
+use ibc::core::client::context::client_state::{ClientStateExecution, ClientStateValidation};
 use ibc::core::client::context::consensus_state::ConsensusState;
 use ibc::core::client::types::error::ClientError;
 use ibc::core::client::types::Height;
@@ -32,15 +33,16 @@ use ibc_proto::ibc::core::commitment::v1::MerkleProof as RawMerkleProof;
 use ibc_query::core::context::{ProvableContext, QueryContext};
 
 use super::types::{MockIbcStore, DEFAULT_BLOCK_TIME_SECS};
-use crate::testapp::ibc::clients::{AnyClientState, AnyConsensusState};
 
-impl<S> ValidationContext for MockIbcStore<S>
+impl<S, ACL, ACS> ValidationContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     type V = Self;
-    type HostClientState = AnyClientState;
-    type HostConsensusState = AnyConsensusState;
+    type HostClientState = ACL;
+    type HostConsensusState = ACS;
 
     fn host_height(&self) -> Result<Height, ContextError> {
         Ok(Height::new(
@@ -79,12 +81,13 @@ where
         &self,
         client_state_of_host_on_counterparty: Self::HostClientState,
     ) -> Result<(), ContextError> {
-        if client_state_of_host_on_counterparty.is_frozen() {
-            return Err(ClientError::ClientFrozen {
-                description: String::new(),
-            }
-            .into());
-        }
+        // // FIXME(rano): is_frozen is specific to Tendermint or Mock client state.
+        // if client_state_of_host_on_counterparty.is_frozen() {
+        //     return Err(ClientError::ClientFrozen {
+        //         description: String::new(),
+        //     }
+        //     .into());
+        // }
 
         let latest_height = self.host_height()?;
 
@@ -269,9 +272,11 @@ where
 }
 
 /// Trait to provide proofs in gRPC service blanket implementations.
-impl<S> ProvableContext for MockIbcStore<S>
+impl<S, ACL, ACS> ProvableContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     /// Returns the proof for the given [`Height`] and [`Path`]
     fn get_proof(&self, height: Height, path: &Path) -> Option<Vec<u8>> {
@@ -294,9 +299,11 @@ where
 }
 
 /// Trait to complete the gRPC service blanket implementations.
-impl<S> QueryContext for MockIbcStore<S>
+impl<S, ACL, ACS> QueryContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     /// Returns the list of all client states.
     fn client_states(&self) -> Result<Vec<(ClientId, ClientStateRef<Self>)>, ContextError> {
@@ -636,9 +643,11 @@ where
     }
 }
 
-impl<S> ExecutionContext for MockIbcStore<S>
+impl<S, ACL, ACS> ExecutionContext for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateExecution<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     type E = Self;
 

ibc-testkit/src/testapp/ibc/core/types.rs

@@ -9,6 +9,7 @@ use basecoin_store::types::{BinStore, JsonStore, ProtobufStore, TypedSet, TypedS
 use ibc::core::channel::types::channel::ChannelEnd;
 use ibc::core::channel::types::commitment::{AcknowledgementCommitment, PacketCommitment};
 use ibc::core::client::context::client_state::ClientStateValidation;
+use ibc::core::client::context::consensus_state::ConsensusState;
 use ibc::core::client::types::Height;
 use ibc::core::connection::types::ConnectionEnd;
 use ibc::core::handler::types::events::IbcEvent;
@@ -32,17 +33,18 @@ use typed_builder::TypedBuilder;
 use crate::context::{MockStore, TestContext};
 use crate::fixtures::core::context::TestContextConfig;
 use crate::hosts::{HostClientState, HostConsensusState, TestBlock, TestHeader, TestHost};
-use crate::testapp::ibc::clients::mock::header::MockHeader;
 use crate::testapp::ibc::clients::{AnyClientState, AnyConsensusState};
 pub const DEFAULT_BLOCK_TIME_SECS: u64 = 3;
 
-pub type DefaultIbcStore = MockIbcStore<MockStore>;
+pub type DefaultIbcStore = MockIbcStore<MockStore, AnyClientState, AnyConsensusState>;
 
 /// An object that stores all IBC related data.
 #[derive(Debug)]
-pub struct MockIbcStore<S>
+pub struct MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     /// chain revision number,
     pub revision_number: Arc<Mutex<u64>>,
@@ -62,10 +64,9 @@ where
     pub client_processed_heights:
         ProtobufStore<SharedStore<S>, ClientUpdateHeightPath, Height, RawHeight>,
     /// A typed-store for AnyClientState
-    pub client_state_store: ProtobufStore<SharedStore<S>, ClientStatePath, AnyClientState, Any>,
+    pub client_state_store: ProtobufStore<SharedStore<S>, ClientStatePath, ACL, Any>,
     /// A typed-store for AnyConsensusState
-    pub consensus_state_store:
-        ProtobufStore<SharedStore<S>, ClientConsensusStatePath, AnyConsensusState, Any>,
+    pub consensus_state_store: ProtobufStore<SharedStore<S>, ClientConsensusStatePath, ACS, Any>,
     /// A typed-store for ConnectionEnd
     pub connection_end_store:
         ProtobufStore<SharedStore<S>, ConnectionPath, ConnectionEnd, RawConnectionEnd>,
@@ -86,7 +87,7 @@ where
     /// A typed-store for packet ack
     pub packet_ack_store: BinStore<SharedStore<S>, AckPath, AcknowledgementCommitment>,
     /// Map of host consensus states
-    pub host_consensus_states: Arc<Mutex<BTreeMap<u64, AnyConsensusState>>>,
+    pub host_consensus_states: Arc<Mutex<BTreeMap<u64, ACS>>>,
     /// Map of older ibc commitment proofs
     pub ibc_commiment_proofs: Arc<Mutex<BTreeMap<u64, CommitmentProof>>>,
     /// IBC Events
@@ -95,9 +96,11 @@ where
     pub logs: Arc<Mutex<Vec<String>>>,
 }
 
-impl<S> MockIbcStore<S>
+impl<S, ACL, ACS> MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     pub fn new(revision_number: u64, store: S) -> Self {
         let shared_store = SharedStore::new(store);
@@ -144,7 +147,7 @@ where
         }
     }
 
-    fn store_host_consensus_state(&mut self, height: u64, consensus_state: AnyConsensusState) {
+    fn store_host_consensus_state(&mut self, height: u64, consensus_state: ACS) {
         self.host_consensus_states
             .lock()
             .insert(height, consensus_state);
@@ -154,12 +157,7 @@ where
         self.ibc_commiment_proofs.lock().insert(height, proof);
     }
 
-    pub fn begin_block(
-        &mut self,
-        height: u64,
-        consensus_state: AnyConsensusState,
-        proof: CommitmentProof,
-    ) {
+    pub fn begin_block(&mut self, height: u64, consensus_state: ACS, proof: CommitmentProof) {
         assert_eq!(self.store.current_height(), height);
         self.store_host_consensus_state(height, consensus_state);
         self.store_ibc_commitment_proof(height, proof);
@@ -178,18 +176,20 @@ where
     }
 }
 
-impl<S> Default for MockIbcStore<S>
+impl<S, ACL, ACS> Default for MockIbcStore<S, ACL, ACS>
 where
     S: ProvableStore + Debug + Default,
+    ACL: ClientStateValidation<Self> + Clone,
+    ACS: ConsensusState + Clone,
 {
     fn default() -> Self {
-        // Note: this creates a MockIbcStore which has MockConsensusState as Host ConsensusState
         let mut ibc_store = Self::new(0, S::default());
         ibc_store.store.commit().expect("no error");
-        ibc_store.store_host_consensus_state(
-            ibc_store.store.current_height(),
-            MockHeader::default().into_consensus_state().into(),
-        );
+        // // FIXME(rano): store a consensus state.
+        // ibc_store.store_host_consensus_state(
+        //     ibc_store.store.current_height(),
+        //     MockHeader::default().into_consensus_state().into(),
+        // );
         ibc_store.store_ibc_commitment_proof(
             ibc_store.store.current_height(),
             CommitmentProof::default(),

tests-integration/tests/core/ics02_client/create_client.rs

@@ -1,4 +1,3 @@
-use basecoin_store::impls::InMemoryStore;
 use ibc::clients::tendermint::types::{
     client_type as tm_client_type, ConsensusState as TmConsensusState,
 };
@@ -28,7 +27,7 @@ use ibc_testkit::testapp::ibc::clients::mock::consensus_state::MockConsensusStat
 use ibc_testkit::testapp::ibc::clients::mock::header::MockHeader;
 use ibc_testkit::testapp::ibc::clients::{AnyClientState, AnyConsensusState};
 use ibc_testkit::testapp::ibc::core::router::MockRouter;
-use ibc_testkit::testapp::ibc::core::types::{DefaultIbcStore, LightClientBuilder, MockIbcStore};
+use ibc_testkit::testapp::ibc::core::types::{DefaultIbcStore, LightClientBuilder};
 use test_log::test;
 
 #[test]
@@ -96,7 +95,7 @@ fn test_tm_create_client_ok() {
     assert!(res.is_ok(), "tendermint client execution happy path");
 
     let expected_client_state =
-        ClientStateRef::<MockIbcStore<InMemoryStore>>::try_from(msg.client_state).unwrap();
+        ClientStateRef::<DefaultIbcStore>::try_from(msg.client_state).unwrap();
     assert_eq!(expected_client_state.client_type(), client_type);
     assert_eq!(ctx.client_state(&client_id).unwrap(), expected_client_state);
 }