feat: add committed status query/store for lightclients

Author: 0xumutkk

cosmwasm/ibc-union/core/msg/src/msg.rs

@@ -51,6 +51,13 @@ pub enum ExecuteMsg {
     PacketSend(MsgSendPacket),
     WriteAcknowledgement(MsgWriteAcknowledgement),
     MigrateState(MsgMigrateState),
+    CommitClientStatus(MsgCommitClientStatus),
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+pub struct MsgCommitClientStatus {
+    pub client_id: ClientId,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]

cosmwasm/ibc-union/core/msg/src/query.rs

@@ -18,6 +18,8 @@ pub enum QueryMsg {
     GetConsensusState { client_id: ClientId, height: u64 },
     #[cfg_attr(feature = "cw-orch-interface", returns(crate::lightclient::Status))]
     GetStatus { client_id: ClientId },
+    #[cfg_attr(feature = "cw-orch-interface", returns(crate::lightclient::Status))]
+    GetCommittedStatus { client_id: ClientId },
     #[cfg_attr(feature = "cw-orch-interface", returns(String))]
     GetClientType { client_id: ClientId },
     #[cfg_attr(feature = "cw-orch-interface", returns(ibc_union_spec::Connection))]

cosmwasm/ibc-union/core/src/contract.rs

@@ -36,14 +36,15 @@ use ibc_union_spec::{
 use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use unionlabs::{
     ethereum::keccak256,
-    primitives::{Bytes, H256},
+    primitives::{Bytes, H256, U256},
 };
 
 use crate::{
     state::{
         ChannelOwner, Channels, ClientConsensusStates, ClientImpls, ClientRegistry, ClientStates,
-        ClientStore, ClientTypes, Commitments, Connections, ContractChannels, NextChannelId,
-        NextClientId, NextConnectionId, QueryStore, WhitelistedRelayers, WhitelistedRelayersAdmin,
+        ClientStatuses, ClientStore, ClientTypes, Commitments, Connections, ContractChannels,
+        NextChannelId, NextClientId, NextConnectionId, QueryStore, WhitelistedRelayers,
+        WhitelistedRelayersAdmin,
     },
     ContractError,
 };
@@ -624,6 +625,19 @@ pub fn execute(
                     .add_attribute("relayer", relayer),
             ))
         }
+        ExecuteMsg::CommitClientStatus(msg) => {
+            let status = query_light_client::<Status>(
+                deps.as_ref(),
+                client_impl(deps.as_ref(), msg.client_id)?,
+                LightClientQuery::GetStatus {
+                    client_id: msg.client_id,
+                },
+            )?;
+            let encoded = U256::from(status as u32);
+            deps.storage
+                .write::<ClientStatuses>(&msg.client_id, &encoded);
+            Ok(Response::default())
+        }
     }
 }
 
@@ -2186,6 +2200,13 @@ pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> Result<Binary, ContractErr
             )?;
             Ok(to_json_binary(&status)?)
         }
+        QueryMsg::GetCommittedStatus { client_id } => {
+            let val = deps.storage.read::<ClientStatuses>(&client_id)?;
+            let raw = val.to_le_bytes()[0];
+            let status = Status::try_from(raw)
+                .map_err(|_| ContractError::InvalidClientStatusValue { value: raw as u32 })?;
+            Ok(to_json_binary(&status)?)
+        }
         QueryMsg::GetChannels { contract } => {
             let contract = deps.api.addr_validate(&contract)?;
             let channels = deps.storage.read::<ContractChannels>(&contract)?;

cosmwasm/ibc-union/core/src/lib.rs

@@ -158,6 +158,11 @@ pub enum ContractError {
     OnlyWhitelistedRelayer,
     #[error("sender is not the relayer admin")]
     OnlyRelayerAdmin,
+    #[error(
+        "{} invalid committed status value: {value}",
+        ContractErrorKind::from(self)
+    )]
+    InvalidClientStatusValue { value: u32 },
 }
 
 impl ContractErrorKind {

cosmwasm/ibc-union/core/src/state.rs

@@ -5,7 +5,7 @@ use depolama::{value::ValueCodecViaEncoding, KeyCodec, Prefix, Store, ValueCodec
 use ibc_union_spec::{Channel, ChannelId, ClientId, Connection, ConnectionId};
 use unionlabs::{
     encoding::Bincode,
-    primitives::{ByteArrayExt, Bytes, H256},
+    primitives::{ByteArrayExt, Bytes, H256, U256},
 };
 
 macro_rules! id_key {
@@ -174,6 +174,24 @@ impl Store for ClientStates {
 id_key!(ClientStates);
 bytes_value!(ClientStates);
 
+pub enum ClientStatuses {}
+impl Store for ClientStatuses {
+    const PREFIX: Prefix = Prefix::new(b"client_status");
+
+    type Key = ClientId;
+    type Value = U256;
+}
+id_key!(ClientStatuses);
+impl ValueCodec<U256> for ClientStatuses {
+    fn encode_value(value: &U256) -> Bytes {
+        value.to_le_bytes().into()
+    }
+
+    fn decode_value(raw: &Bytes) -> StdResult<U256> {
+        read_fixed_bytes(raw).map(U256::from_le_bytes)
+    }
+}
+
 pub enum ClientConsensusStates {}
 impl Store for ClientConsensusStates {
     const PREFIX: Prefix = Prefix::new(b"client_consensus_states");

lib/ibc-union-spec/src/types.rs

@@ -96,6 +96,7 @@ id!(ChannelId);
 #[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(deny_unknown_fields, rename_all = "snake_case")]
+#[repr(u8)]
 pub enum Status {
     Active = 1,
     Expired = 2,
@@ -111,3 +112,16 @@ impl fmt::Display for Status {
         })
     }
 }
+
+impl TryFrom<u8> for Status {
+    type Error = &'static str;
+
+    fn try_from(value: u8) -> Result<Self, Self::Error> {
+        match value {
+            1 => Ok(Status::Active),
+            2 => Ok(Status::Expired),
+            3 => Ok(Status::Frozen),
+            _ => Err("Invalid status value"),
+        }
+    }
+}

voyager/modules/state/cosmos-sdk-union/src/main.rs

@@ -368,6 +368,29 @@ impl Module {
 
         Ok(commitment.flatten())
     }
+
+    #[instrument(
+        skip_all,
+        fields(
+            chain_id = %self.chain_id,
+            %height,
+            %client_id
+        )
+    )]
+    async fn query_committed_client_status(
+        &self,
+        height: Height,
+        client_id: ClientId,
+    ) -> RpcResult<Option<Status>> {
+        let commitment = self
+            .query_smart::<_, Option<Status>>(
+                &ibc_union_msg::query::QueryMsg::GetCommittedStatus { client_id },
+                Some(height),
+            )
+            .await?;
+
+        Ok(commitment.flatten())
+    }
 }
 
 #[derive(Debug, thiserror::Error)]

voyager/modules/state/ethereum/src/main.rs

@@ -623,6 +623,15 @@ impl Module {
             )),
         }
     }
+
+    #[instrument(skip_all,fields(chain_id = %self.chain_id, %height, %client_id))]
+    async fn query_committed_client_status(
+        &self,
+        height: Height,
+        client_id: ClientId,
+    ) -> RpcResult<Option<Status>> {
+        unimplemented!("query_client_status is not implemented yet");
+    }
 }
 
 fn mk_windows(mut latest_height: u64, window: u64) -> Vec<(BlockNumberOrTag, BlockNumberOrTag)> {