Merge branch 'main' into feat/refactor-testkit

.github/workflows/upload-cw-clients.yaml

@@ -0,0 +1,96 @@
+name: Upload CosmWasm clients as Github workflow artifact
+on:
+  pull_request:
+    paths:
+      - .github/workflows/upload-cw-clients.yaml
+      - Cargo.toml
+      - ci/**
+      - ibc/**
+      - ibc-core/**
+      - ibc-apps/**
+      - ibc-data-types/**
+      - ibc-clients/**
+      - ibc-primitives/**
+      - ibc-query/**
+      - ibc-testkit/**
+      - ibc-derive/**
+  push:
+    branches: main
+    paths:
+      - .github/workflows/upload-cw-clients.yaml
+      - Cargo.toml
+      - ci/**
+      - ibc/**
+      - ibc-core/**
+      - ibc-apps/**
+      - ibc-data-types/**
+      - ibc-clients/**
+      - ibc-primitives/**
+      - ibc-query/**
+      - ibc-testkit/**
+      - ibc-derive/**
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  upload-tendermint-cw-client:
+    name: Compile and upload Tendermint CosmWasm client
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      # `cosmwasm/optimizer` requires `Cargo.lock`. but currently,
+      # `Cargo.lock` is not committed, because `ibc-rs` is treated as library.
+      - name: Produce `Cargo.lock` file
+        run: cargo update -p ibc-client-tendermint-cw
+
+      - name: Create mount directories
+        run: mkdir -p "${HOME}/.cargo/registry" "$(pwd)"/target
+
+      - name: Compile cosmwasm blob for tendermint light client
+        run: |
+          docker run \
+          -v "$(pwd)":/code \
+          -v "$(pwd)"/target:/target \
+          -v "${HOME}/.cargo/registry":/usr/local/cargo/registry \
+          cosmwasm/optimizer:0.15.1 ./ibc-clients/ics07-tendermint/cw-contract
+
+      - name: Fix permissions
+        run: |
+          sudo chown -R $(id -u):$(id -g) "$(pwd)"/target
+          sudo chown -R $(id -u):$(id -g) "${HOME}/.cargo/registry"
+
+      - name: Install `cosmwasm-check` from crates.io
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: cosmwasm-check
+
+      - name: Check compiled CosmWasm contract
+        working-directory: artifacts
+        run: |
+          sha256sum -c checksums.txt
+          cosmwasm-check ibc_client_tendermint_cw.wasm
+
+      - name: Upload compiled CosmWasm contract
+        uses: actions/upload-artifact@v4
+        with:
+          name: tendermint-cw-${{ github.sha }}
+          path: artifacts/ibc_client_tendermint_cw.wasm
+          # Retain the artifact for 1 week for PRs and 3 months for `main` branch
+          retention-days: ${{ github.event_name == 'pull_request' && 7 || 90 }}
+          overwrite: true
+
+  # # An example workflow to download the artifact:
+  # download-tendermint-cw-client:
+  #   name: Download pre-compiled Tendermint CosmWasm client
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/download-artifact@v4
+  #       with:
+  #         name: tendermint-cw-${{ env.IBC_RS_COMMIT_HASH }}
+  #         repository: cosmos/ibc-rs
+  #     - run: ls -l ibc_client_tendermint_cw.wasm

Cargo.toml

@@ -119,6 +119,7 @@ tendermint-testgen               = { version = "0.34.0", default-features = fals
 cosmwasm-schema    = { version = "1.5.2" }
 cosmwasm-std       = { version = "1.5.2" }
 cosmwasm-vm        = { version = "1.5.2" }
+cw-storage-plus    = { version = "1.2.0" }
 
 # parity dependencies
 parity-scale-codec = { version = "3.6.5", default-features = false, features = ["full"] }

ibc-clients/README.md

@@ -27,6 +27,14 @@ IBC light clients:
 - [ibc-client-tendermint](./ics07-tendermint): Implementation
 - [ibc-client-tendermint-cw](./ics07-tendermint/cw-contract): CosmWasm Contract
 
+> [!TIP]
+> The pre-compiled CosmWasm contract for `ibc-client-tendermint-cw` is available
+> as Github workflow artifacts at
+> [_Actions_](https://github.com/cosmos/ibc-rs/actions/workflows/upload-cw-clients.yaml)
+> tab. They can be downloaded
+> [during a Github workflow](https://github.com/cosmos/ibc-rs/blob/1098f252c04152812f026520e28e323f3bc0507e/.github/workflows/upload-cw-clients.yaml#L87-L96)
+> using `actions/download-artifact@v4` action.
+
 ### ICS-08: WASM Proxy Light Client
 
 - [ibc-client-wasm-types](./ics08-wasm/types)

ibc-clients/cw-context/Cargo.toml

@@ -28,6 +28,7 @@ ibc-client-wasm-types = { workspace = true, features = ["cosmwasm"] }
 # cosmwasm dependencies
 cosmwasm-schema       = { workspace = true }
 cosmwasm-std          = { workspace = true }
+cw-storage-plus       = { workspace = true }
 
 [features]
 default = ["std"]

ibc-clients/cw-context/src/context/client_ctx.rs

@@ -7,12 +7,13 @@ use ibc_core::client::types::error::ClientError;
 use ibc_core::client::types::Height;
 use ibc_core::handler::types::error::ContextError;
 use ibc_core::host::types::identifiers::ClientId;
-use ibc_core::host::types::path::{iteration_key, ClientConsensusStatePath, ClientStatePath};
+use ibc_core::host::types::path::{ClientConsensusStatePath, ClientStatePath};
 use ibc_core::primitives::proto::{Any, Protobuf};
 use ibc_core::primitives::Timestamp;
 
-use super::Context;
+use super::{Context, StorageMut};
 use crate::api::ClientType;
+use crate::context::CONSENSUS_STATE_HEIGHT_MAP;
 use crate::utils::AnyCodec;
 
 impl<'a, C: ClientType<'a>> ClientValidationContext for Context<'a, C> {
@@ -154,11 +155,15 @@ impl<'a, C: ClientType<'a>> ClientExecutionContext for Context<'a, C> {
 
         self.insert(prefixed_height_key, revision_height_vec);
 
-        let iteration_key = iteration_key(height.revision_number(), height.revision_height());
-
-        let height_vec = height.to_string().into_bytes();
-
-        self.insert(iteration_key, height_vec);
+        CONSENSUS_STATE_HEIGHT_MAP
+            .save(
+                self.storage_mut(),
+                (height.revision_number(), height.revision_height()),
+                &Default::default(),
+            )
+            .map_err(|e| ClientError::Other {
+                description: e.to_string(),
+            })?;
 
         Ok(())
     }
@@ -180,9 +185,10 @@ impl<'a, C: ClientType<'a>> ClientExecutionContext for Context<'a, C> {
 
         self.remove(prefixed_height_key);
 
-        let iteration_key = iteration_key(height.revision_number(), height.revision_height());
-
-        self.remove(iteration_key);
+        CONSENSUS_STATE_HEIGHT_MAP.remove(
+            self.storage_mut(),
+            (height.revision_number(), height.revision_height()),
+        );
 
         Ok(())
     }

ibc-clients/cw-context/src/context/mod.rs

@@ -3,7 +3,8 @@ pub mod custom_ctx;
 
 use std::str::FromStr;
 
-use cosmwasm_std::{Deps, DepsMut, Env, Order, Storage};
+use cosmwasm_std::{Deps, DepsMut, Empty, Env, Order, Storage};
+use cw_storage_plus::{Bound, Map};
 use ibc_client_wasm_types::client_state::ClientState as WasmClientState;
 use ibc_core::client::context::client_state::ClientStateCommon;
 use ibc_core::client::types::error::ClientError;
@@ -18,10 +19,18 @@ use prost::Message;
 
 use crate::api::ClientType;
 use crate::types::{ContractError, GenesisMetadata, HeightTravel, MigrationPrefix};
-use crate::utils::{parse_height, AnyCodec};
+use crate::utils::AnyCodec;
 
 type Checksum = Vec<u8>;
 
+/// - [`Height`] can not be used directly as keys in the map,
+/// as it doesn't implement some cw_storage specific traits.
+/// - Only a sorted set is needed. So the value type is set to
+/// [`Empty`] following
+/// ([cosmwasm-book](https://book.cosmwasm.com/cross-contract/map-storage.html#maps-as-sets)).
+pub const CONSENSUS_STATE_HEIGHT_MAP: Map<'_, (u64, u64), Empty> =
+    Map::new(ITERATE_CONSENSUS_STATE_PREFIX);
+
 /// Context is a wrapper around the deps and env that gives access to the
 /// methods under the ibc-rs Validation and Execution traits.
 pub struct Context<'a, C: ClientType<'a>> {
@@ -130,13 +139,16 @@ impl<'a, C: ClientType<'a>> Context<'a, C> {
 
     /// Returns the storage of the context.
     pub fn get_heights(&self) -> Result<Vec<Height>, ClientError> {
-        let iterator = self.storage_ref().range(None, None, Order::Ascending);
-
-        let heights: Vec<_> = iterator
-            .filter_map(|(_, value)| parse_height(value).transpose())
-            .collect::<Result<_, _>>()?;
-
-        Ok(heights)
+        CONSENSUS_STATE_HEIGHT_MAP
+            .keys(self.storage_ref(), None, None, Order::Ascending)
+            .map(|deserialized_result| {
+                let (rev_number, rev_height) =
+                    deserialized_result.map_err(|e| ClientError::Other {
+                        description: e.to_string(),
+                    })?;
+                Height::new(rev_number, rev_height)
+            })
+            .collect()
     }
 
     /// Searches for either the earliest next or latest previous height based on
@@ -146,22 +158,37 @@ impl<'a, C: ClientType<'a>> Context<'a, C> {
         height: &Height,
         travel: HeightTravel,
     ) -> Result<Option<Height>, ClientError> {
-        let iteration_key = iteration_key(height.revision_number(), height.revision_height());
-
-        let mut iterator = match travel {
-            HeightTravel::Prev => {
-                self.storage_ref()
-                    .range(None, Some(&iteration_key), Order::Descending)
-            }
-            HeightTravel::Next => {
-                self.storage_ref()
-                    .range(Some(&iteration_key), None, Order::Ascending)
-            }
+        let iterator = match travel {
+            HeightTravel::Prev => CONSENSUS_STATE_HEIGHT_MAP.range(
+                self.storage_ref(),
+                None,
+                Some(Bound::exclusive((
+                    height.revision_number(),
+                    height.revision_height(),
+                ))),
+                Order::Descending,
+            ),
+            HeightTravel::Next => CONSENSUS_STATE_HEIGHT_MAP.range(
+                self.storage_ref(),
+                Some(Bound::exclusive((
+                    height.revision_number(),
+                    height.revision_height(),
+                ))),
+                None,
+                Order::Ascending,
+            ),
         };
 
         iterator
+            .map(|deserialized_result| {
+                let ((rev_number, rev_height), _) =
+                    deserialized_result.map_err(|e| ClientError::Other {
+                        description: e.to_string(),
+                    })?;
+                Height::new(rev_number, rev_height)
+            })
             .next()
-            .map_or(Ok(None), |(_, height)| parse_height(height))
+            .transpose()
     }
 
     /// Returns the key for the client update time.
@@ -191,38 +218,48 @@ impl<'a, C: ClientType<'a>> Context<'a, C> {
     pub fn get_metadata(&self) -> Result<Option<Vec<GenesisMetadata>>, ContractError> {
         let mut metadata = Vec::<GenesisMetadata>::new();
 
-        let start_key = ITERATE_CONSENSUS_STATE_PREFIX.to_string().into_bytes();
-
-        let iterator = self
-            .storage_ref()
-            .range(Some(&start_key), None, Order::Ascending);
-
-        for (_, encoded_height) in iterator {
-            let height = parse_height(encoded_height)?;
-
-            match height {
-                Some(height) => {
-                    let processed_height_key = self.client_update_height_key(&height);
-                    metadata.push(GenesisMetadata {
-                        key: processed_height_key.clone(),
-                        value: self.retrieve(&processed_height_key)?,
-                    });
-                    let processed_time_key = self.client_update_time_key(&height);
-                    metadata.push(GenesisMetadata {
-                        key: processed_time_key.clone(),
-                        value: self.retrieve(&processed_time_key)?,
-                    });
-                }
-                None => continue,
-            }
+        let iterator = CONSENSUS_STATE_HEIGHT_MAP
+            .keys(self.storage_ref(), None, None, Order::Ascending)
+            .map(|deserialized_result| {
+                let (rev_number, rev_height) =
+                    deserialized_result.map_err(|e| ClientError::Other {
+                        description: e.to_string(),
+                    })?;
+                Height::new(rev_number, rev_height)
+            });
+
+        for height_result in iterator {
+            let height = height_result?;
+
+            let processed_height_key = self.client_update_height_key(&height);
+            metadata.push(GenesisMetadata {
+                key: processed_height_key.clone(),
+                value: self.retrieve(&processed_height_key)?,
+            });
+            let processed_time_key = self.client_update_time_key(&height);
+            metadata.push(GenesisMetadata {
+                key: processed_time_key.clone(),
+                value: self.retrieve(&processed_time_key)?,
+            });
         }
 
-        let iterator = self
-            .storage_ref()
-            .range(Some(&start_key), None, Order::Ascending);
+        let iterator = CONSENSUS_STATE_HEIGHT_MAP
+            .keys(self.storage_ref(), None, None, Order::Ascending)
+            .map(|deserialized_result| {
+                let (rev_number, rev_height) =
+                    deserialized_result.map_err(|e| ClientError::Other {
+                        description: e.to_string(),
+                    })?;
+                Height::new(rev_number, rev_height)
+            });
+
+        for height_result in iterator {
+            let height = height_result?;
 
-        for (key, height) in iterator {
-            metadata.push(GenesisMetadata { key, value: height });
+            metadata.push(GenesisMetadata {
+                key: iteration_key(height.revision_number(), height.revision_height()),
+                value: height.encode_vec(),
+            });
         }
 
         Ok(Some(metadata))

ibc-clients/cw-context/src/lib.rs

@@ -18,8 +18,6 @@
 )]
 #![forbid(unsafe_code)]
 
-extern crate alloc;
-
 pub mod api;
 pub mod context;
 pub mod handlers;

ibc-clients/cw-context/src/utils/mod.rs

@@ -1,25 +1,3 @@
 mod codec;
 
 pub use codec::*;
-use ibc_core::client::types::error::ClientError;
-use ibc_core::client::types::{Height, HeightError};
-
-/// Decodes a `Height` from a UTF-8 encoded byte array.
-pub fn parse_height(encoded_height: Vec<u8>) -> Result<Option<Height>, ClientError> {
-    let height_str = match alloc::str::from_utf8(encoded_height.as_slice()) {
-        Ok(s) => s,
-        // In cases where the height is unavailable, the encoded representation
-        // might not be valid UTF-8, resulting in an invalid string. In such
-        // instances, we return None.
-        Err(_) => return Ok(None),
-    };
-    match Height::try_from(height_str) {
-        Ok(height) => Ok(Some(height)),
-        // This is a valid case, as the key may contain other data. We just skip
-        // it.
-        Err(HeightError::InvalidFormat { .. }) => Ok(None),
-        Err(e) => Err(ClientError::Other {
-            description: e.to_string(),
-        }),
-    }
-}