Hide ibc::Timestamp::now() behind clock feature flag

informalsystems · Jan 14, 2022 · e6eb14d · e6eb14d
1 parent efcd884
commit e6eb14d
Show file tree

Hide file tree

Showing 12 changed files with 85 additions and 43 deletions.
diff --git a/modules/Cargo.toml b/modules/Cargo.toml
@@ -17,11 +17,13 @@ description  = """
 all-features = true
 
 [features]
-default = ["flex-error/std", "flex-error/eyre_tracer"]
+default = ["std"]
+std = ["flex-error/std", "flex-error/eyre_tracer", "clock"]
+clock = ["tendermint/clock", "time/std"]
 
 # This feature grants access to development-time mocking libraries, such as `MockContext` or `MockHeader`.
 # Depends on the `testgen` suite for generating Tendermint light blocks.
-mocks = ["tendermint-testgen"]
+mocks = ["tendermint-testgen", "clock"]
 
 [dependencies]
 # Proto definitions for all IBC-related interfaces, e.g., connections or channels.
@@ -43,9 +45,11 @@ flex-error = { version = "0.4.4", default-features = false }
 
 [dependencies.tendermint]
 version = "=0.23.5"
+default-features = false
 
 [dependencies.tendermint-proto]
 version = "=0.23.5"
+default-features = false
 
 [dependencies.tendermint-light-client-verifier]
 version = "=0.23.5"
@@ -54,6 +58,7 @@ default-features = false
 [dependencies.tendermint-testgen]
 version = "=0.23.5"
 optional = true
+default-features = false
 
 [dev-dependencies]
 env_logger = "0.9.0"

diff --git a/modules/src/clients/ics07_tendermint/client_def.rs b/modules/src/clients/ics07_tendermint/client_def.rs
@@ -2,10 +2,10 @@ use core::convert::TryInto;
 
 use ibc_proto::ibc::core::commitment::v1::MerkleProof as RawMerkleProof;
 use prost::Message;
+use tendermint::Time;
 use tendermint_light_client_verifier::types::{TrustedBlockState, UntrustedBlockState};
 use tendermint_light_client_verifier::{ProdVerifier, Verdict, Verifier};
 use tendermint_proto::Protobuf;
-use time::OffsetDateTime;
 
 use crate::clients::ics07_tendermint::client_state::ClientState;
 use crate::clients::ics07_tendermint::consensus_state::ConsensusState;
@@ -46,6 +46,7 @@ impl ClientDef for TendermintClient {
 
     fn check_header_and_update_state(
         &self,
+        now: Time,
         ctx: &dyn ClientReader,
         client_id: ClientId,
         client_state: Self::ClientState,
@@ -108,12 +109,9 @@ impl ClientDef for TendermintClient {
 
         let options = client_state.as_light_client_options()?;
 
-        let verdict = self.verifier.verify(
-            untrusted_state,
-            trusted_state,
-            &options,
-            OffsetDateTime::now_utc().try_into().unwrap(),
-        );
+        let verdict = self
+            .verifier
+            .verify(untrusted_state, trusted_state, &options, now);
 
         match verdict {
             Verdict::Success => {}

diff --git a/modules/src/core/ics02_client/client_def.rs b/modules/src/core/ics02_client/client_def.rs
@@ -1,4 +1,5 @@
 use ibc_proto::ibc::core::commitment::v1::MerkleProof;
+use tendermint::Time;
 
 use crate::clients::ics07_tendermint::client_def::TendermintClient;
 use crate::core::ics02_client::client_consensus::{AnyConsensusState, ConsensusState};
@@ -29,6 +30,7 @@ pub trait ClientDef: Clone {
 
     fn check_header_and_update_state(
         &self,
+        now: Time,
         ctx: &dyn ClientReader,
         client_id: ClientId,
         client_state: Self::ClientState,
@@ -195,6 +197,7 @@ impl ClientDef for AnyClient {
     /// Validates an incoming `header` against the latest consensus state of this client.
     fn check_header_and_update_state(
         &self,
+        now: Time,
         ctx: &dyn ClientReader,
         client_id: ClientId,
         client_state: AnyClientState,
@@ -208,8 +211,13 @@ impl ClientDef for AnyClient {
                 )
                 .ok_or_else(|| Error::client_args_type_mismatch(ClientType::Tendermint))?;
 
-                let (new_state, new_consensus) =
-                    client.check_header_and_update_state(ctx, client_id, client_state, header)?;
+                let (new_state, new_consensus) = client.check_header_and_update_state(
+                    now,
+                    ctx,
+                    client_id,
+                    client_state,
+                    header,
+                )?;
 
                 Ok((
                     AnyClientState::Tendermint(new_state),
@@ -225,8 +233,13 @@ impl ClientDef for AnyClient {
                 )
                 .ok_or_else(|| Error::client_args_type_mismatch(ClientType::Mock))?;
 
-                let (new_state, new_consensus) =
-                    client.check_header_and_update_state(ctx, client_id, client_state, header)?;
+                let (new_state, new_consensus) = client.check_header_and_update_state(
+                    now,
+                    ctx,
+                    client_id,
+                    client_state,
+                    header,
+                )?;
 
                 Ok((
                     AnyClientState::Mock(new_state),

diff --git a/modules/src/core/ics02_client/handler.rs b/modules/src/core/ics02_client/handler.rs
@@ -1,5 +1,7 @@
 //! This module implements the processing logic for ICS2 (client abstractions and functions) msgs.
 
+use tendermint::Time;
+
 use crate::core::ics02_client::context::ClientReader;
 use crate::core::ics02_client::error::Error;
 use crate::core::ics02_client::msgs::ClientMsg;
@@ -17,13 +19,17 @@ pub enum ClientResult {
 }
 
 /// General entry point for processing any message related to ICS2 (client functions) protocols.
-pub fn dispatch<Ctx>(ctx: &Ctx, msg: ClientMsg) -> Result<HandlerOutput<ClientResult>, Error>
+pub fn dispatch<Ctx>(
+    now: Time,
+    ctx: &Ctx,
+    msg: ClientMsg,
+) -> Result<HandlerOutput<ClientResult>, Error>
 where
     Ctx: ClientReader,
 {
     match msg {
-        ClientMsg::CreateClient(msg) => create_client::process(ctx, msg),
-        ClientMsg::UpdateClient(msg) => update_client::process(ctx, msg),
+        ClientMsg::CreateClient(msg) => create_client::process(now, ctx, msg),
+        ClientMsg::UpdateClient(msg) => update_client::process(now, ctx, msg),
         ClientMsg::UpgradeClient(msg) => upgrade_client::process(ctx, msg),
         _ => {
             unimplemented!()

diff --git a/modules/src/core/ics02_client/handler/create_client.rs b/modules/src/core/ics02_client/handler/create_client.rs
@@ -1,4 +1,7 @@
 //! Protocol logic specific to processing ICS2 messages of type `MsgCreateAnyClient`.
+
+use tendermint::Time;
+
 use crate::prelude::*;
 
 use crate::core::ics02_client::client_consensus::AnyConsensusState;
@@ -27,6 +30,7 @@ pub struct Result {
 }
 
 pub fn process(
+    now: Time,
     ctx: &dyn ClientReader,
     msg: MsgCreateAnyClient,
 ) -> HandlerResult<ClientResult, Error> {
@@ -48,7 +52,7 @@ pub fn process(
         client_type: msg.client_state().client_type(),
         client_state: msg.client_state(),
         consensus_state: msg.consensus_state(),
-        processed_time: Timestamp::now(),
+        processed_time: now.into(),
         processed_height: ctx.host_height(),
     });
 
@@ -66,6 +70,7 @@ mod tests {
     use crate::prelude::*;
 
     use core::time::Duration;
+    use tendermint::Time;
     use test_log::test;
 
     use crate::clients::ics07_tendermint::client_state::{
@@ -102,7 +107,7 @@ mod tests {
         )
         .unwrap();
 
-        let output = dispatch(&ctx, ClientMsg::CreateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::CreateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -193,7 +198,7 @@ mod tests {
         let expected_client_id = ClientId::new(ClientType::Mock, 0).unwrap();
 
         for msg in create_client_msgs {
-            let output = dispatch(&ctx, ClientMsg::CreateClient(msg.clone()));
+            let output = dispatch(Time::now(), &ctx, ClientMsg::CreateClient(msg.clone()));
 
             match output {
                 Ok(HandlerOutput {
@@ -255,7 +260,7 @@ mod tests {
         )
         .unwrap();
 
-        let output = dispatch(&ctx, ClientMsg::CreateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::CreateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {

diff --git a/modules/src/core/ics02_client/handler/update_client.rs b/modules/src/core/ics02_client/handler/update_client.rs
@@ -1,5 +1,7 @@
 //! Protocol logic specific to processing ICS2 messages of type `MsgUpdateAnyClient`.
 
+use core::convert::From;
+use tendermint::Time;
 use tracing::debug;
 
 use crate::core::ics02_client::client_consensus::AnyConsensusState;
@@ -27,6 +29,7 @@ pub struct Result {
 }
 
 pub fn process(
+    now: Time,
     ctx: &dyn ClientReader,
     msg: MsgUpdateAnyClient,
 ) -> HandlerResult<ClientResult, Error> {
@@ -59,12 +62,12 @@ pub fn process(
 
     debug!("latest consensus state: {:?}", latest_consensus_state);
 
-    let duration = Timestamp::now()
+    let duration = Timestamp::from(now)
         .duration_since(&latest_consensus_state.timestamp())
         .ok_or_else(|| {
             Error::invalid_consensus_state_timestamp(
                 latest_consensus_state.timestamp(),
-                header.timestamp(),
+                Timestamp::from(now),
             )
         })?;
 
@@ -79,7 +82,7 @@ pub fn process(
     // This function will return the new client_state (its latest_height changed) and a
     // consensus_state obtained from header. These will be later persisted by the keeper.
     let (new_client_state, new_consensus_state) = client_def
-        .check_header_and_update_state(ctx, client_id.clone(), client_state, header)
+        .check_header_and_update_state(now, ctx, client_id.clone(), client_state, header)
         .map_err(|e| Error::header_verification_failure(e.to_string()))?;
 
     let result = ClientResult::Update(Result {
@@ -100,6 +103,7 @@ pub fn process(
 #[cfg(test)]
 mod tests {
     use core::str::FromStr;
+    use tendermint::Time;
     use test_log::test;
 
     use crate::core::ics02_client::client_consensus::AnyConsensusState;
@@ -139,7 +143,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -186,7 +190,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
         match output {
             Err(Error(ErrorDetail::ClientNotFound(e), _)) => {
@@ -222,7 +226,7 @@ mod tests {
                 signer: signer.clone(),
             };
 
-            let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+            let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
             match output {
                 Ok(HandlerOutput {
@@ -289,7 +293,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -366,7 +370,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -446,7 +450,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -520,7 +524,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpdateClient(msg));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpdateClient(msg));
 
         match output {
             Ok(_) => {

diff --git a/modules/src/core/ics02_client/handler/upgrade_client.rs b/modules/src/core/ics02_client/handler/upgrade_client.rs
@@ -78,6 +78,7 @@ mod tests {
     use crate::prelude::*;
 
     use core::str::FromStr;
+    use tendermint::Time;
 
     use crate::core::ics02_client::error::{Error, ErrorDetail};
     use crate::core::ics02_client::handler::dispatch;
@@ -117,7 +118,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpgradeClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpgradeClient(msg.clone()));
 
         match output {
             Ok(HandlerOutput {
@@ -168,7 +169,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpgradeClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpgradeClient(msg.clone()));
 
         match output {
             Err(Error(ErrorDetail::ClientNotFound(e), _)) => {
@@ -202,7 +203,7 @@ mod tests {
             signer,
         };
 
-        let output = dispatch(&ctx, ClientMsg::UpgradeClient(msg.clone()));
+        let output = dispatch(Time::now(), &ctx, ClientMsg::UpgradeClient(msg.clone()));
 
         match output {
             Err(Error(ErrorDetail::LowUpgradeHeight(e), _)) => {