Merge branch 'main' into sean/client-update-misbehaviour

Author: seanchen1991

.changelog/unreleased/breaking-changes/973-update-meta.md

@@ -0,0 +1,6 @@
+- Merge client update time and height modification method pairs into
+  one, that is replace
+  a) client_update_{time,height} by update_meta,
+  b) store_update_{time,height} by store_update_meta and
+  c) delete_update_{time,height} by delete_update_meta.
+  ([\#972](https://github.com/cosmos/ibc-rs/pull/972))

.changelog/unreleased/feature/1065-add-new-storage-paths.md

@@ -0,0 +1,2 @@
+- [ibc-core-host] Add remaining storage paths.
+  ([\#1065](https://github.com/cosmos/ibc-rs/issues/1065))

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,13 +1,13 @@
 ---
-name: Bug Report 
+name: Bug Report
 about: Create a report to help us squash bugs!
 
 ---
 
-<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ 
-v               ✰  Thanks for opening an issue! ✰    
+<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
+v               ✰  Thanks for opening an issue! ✰
 v    Before smashing the submit button please review the template.
-v    Please also ensure that this is not a duplicate issue :)  
+v    Please also ensure that this is not a duplicate issue :)
 ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
 
 ## Bug Summary

.github/ISSUE_TEMPLATE/feature-request.md

@@ -4,11 +4,11 @@ about: Create a proposal to request a feature!
 
 ---
 
-<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ 
-v                ✰  Thanks for opening an issue! ✰    
+<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
+v                ✰  Thanks for opening an issue! ✰
 v    Before smashing the submit button please review the template.
-v    Word of caution: poorly thought-out proposals may be rejected 
-v                     without deliberation 
+v    Word of caution: poorly thought-out proposals may be rejected
+v                     without deliberation
 ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
 
 ## Feature Summary

.github/ISSUE_TEMPLATE/process-improvement.md

@@ -5,17 +5,17 @@ about: Create a proposal to suggest an improvement for `ibc-rs` operations!
 ---
 
 <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
-v                ✰  Thanks for opening an issue! ✰    
+v                ✰  Thanks for opening an issue! ✰
 v    Before smashing the submit button please review the template.
 v    Please also ensure that this is not a duplicate issue :)
 ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
 
 ## Improvement Summary
 
-<!-- Short description of the proposed improvement about the projects' processes -->
+<!-- Short description of the proposed improvement of the projects' processes -->
 
 ## Proposal
 
-<!-- Describe your proposal for how some process of `ibc-rs` should be improved -->
+<!-- Describe your proposal for how some processes of `ibc-rs` should be improved -->
 <!-- What would be the benefits if we adopted the proposal?
      Are there any disadvantages? -->

.github/workflows/audit.yaml

@@ -1,7 +1,7 @@
 name: Security Audit
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   security_audit:

.github/workflows/code-quality.yml

@@ -0,0 +1,21 @@
+name: Code Quality Checks
+on:
+  pull_request:
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-latest
+    env:
+      RIPGREP_VERSION: 14.1.0
+      FD_VERSION: 9.0.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Whitestapace lints
+        run: bash ci/code-quality/whitespace-lints.sh
+
+      - name: Spell Check with Typos
+        uses: crate-ci/typos@master
+        with:
+          config: ./.github/typos.toml

.github/workflows/cw-check.yaml

@@ -8,7 +8,7 @@ on:
     tags:
       - v[0-9]+.*
     branches:
-      - 'release/*'
+      - "release/*"
       - main
     paths:
       - .github/workflows/cw-check.yml
@@ -31,9 +31,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: DeterminateSystems/nix-installer-action@main
       - uses: DeterminateSystems/magic-nix-cache-action@main
-        with:
-          is_ci : true
       - name: Run cw-check
         run: |
           cd ci/cw-check
-          nix-shell --run "cw-check"
+          nix-shell --run "cw-check"

.github/workflows/markdown-link-check.yml

@@ -2,7 +2,7 @@ name: Check Markdown links
 
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
   workflow_dispatch:
 
@@ -14,6 +14,6 @@ jobs:
       - name: markdown-link-check
         uses: gaurav-nelson/[email protected]
         with:
-          config-file: '.github/markdown-link-check.json'
-          use-quiet-mode: 'yes'
-          use-verbose-mode: 'yes'
+          config-file: ".github/markdown-link-check.json"
+          use-quiet-mode: "yes"
+          use-verbose-mode: "yes"

.github/workflows/release.yaml

@@ -1,6 +1,6 @@
-# Attempts to perform a release when a particular tag is pushed. This job uses 
-# the `cargo release` command and assumes that the `CRATES_TOKEN`secret has 
-# been set and contains an API token with which we can publish our crates to 
+# Attempts to perform a release when a particular tag is pushed. This job uses
+# the `cargo release` command and assumes that the `CRATES_TOKEN`secret has
+# been set and contains an API token with which we can publish our crates to
 # crates.io.
 #
 # The `ibc-derive` publishing process is managed manually since it's not
@@ -51,7 +51,7 @@ jobs:
         run: yes | cargo release --workspace --no-push --no-tag --exclude ibc-derive --allow-branch HEAD --execute
         env:
           CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
-  
+
   gh-release:
     if: github.ref_type == 'tag'
     name: Create GitHub release

.github/workflows/rust.yml

@@ -29,7 +29,7 @@ on:
       - ibc-query/**
       - ibc-testkit/**
       - ibc-derive/**
-      
+
 env:
   CARGO_INCREMENTAL: 0
   CARGO_PROFILE_DEV_DEBUG: 1
@@ -42,10 +42,10 @@ jobs:
   cleanup-runs:
     runs-on: ubuntu-latest
     steps:
-    - uses: rokroskar/workflow-run-cleanup-action@master
-      env:
-        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-    if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'"
+      - uses: rokroskar/workflow-run-cleanup-action@master
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+    if: ${{ !startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main' }}
 
   check-features:
     name: Check features
@@ -120,7 +120,7 @@ jobs:
         with:
           command: doc
           args: --all-features --release
-    
+
   doc_no_default_features:
     runs-on: ubuntu-latest
     steps:

.github/workflows/typos.yml

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -euo pipefail
+
+# use ggrep for macOS, and grep for Linux
+case "$OSTYPE" in
+    darwin*) GREP="ggrep" ;;
+    linux-gnu*) GREP="grep" ;;
+    *) echo "Unknown OS: $OSTYPE" && exit 1 ;;
+esac
+
+check_binary() {
+    # exactly one argument is passed
+    if [ $# -ne 1 ] || [ "$1" = "" ]; then
+        echo "Usage: check_binary <binary>"
+        exit 1
+    fi
+
+    if ! (type "$1" >/dev/null 2>&1); then
+        echo "$1 is not present"
+        exit 1
+    fi
+}
+
+check_binary "$GREP"
+check_binary find
+
+check_code_quality() {
+    # exactly three arguments are passed
+    if [ $# -ne 3 ] || [ "$1" = "" ] || [ "$2" = "" ] || [ "$3" = "" ]; then
+        echo "Usage: check_code_quality <option> <pattern> <message>"
+        exit 1
+    fi
+
+    if find . -type f -name "*.toml" -o -name "*.rs" \
+        -not -path '*/.*' -not -path '*/target/*' \
+        -exec "$GREP" "$1" "$2" {} \; | "$GREP" '.*'; then
+        echo "$3"
+        return 1
+    else
+        return 0
+    fi
+}
+
+exit_code=0
+
+check_code_quality -nHIP "\s+$" "found: trailing whitespaces" || exit_code=1
+check_code_quality -nHIP $"\t" "found: tabs" || exit_code=1
+check_code_quality -zLIP ".*\n\Z" "found: no newline at EOF" || exit_code=1
+
+if [ "$exit_code" -eq 0 ]; then
+    echo "All code quality checks passed successfully."
+fi
+
+exit "$exit_code"

ci/code-quality/whitespace-lints.sh

@@ -22,4 +22,4 @@ debug-assertions = false
 opt-level = "s"
 overflow-checks = true
 panic = "abort"
-rpath = false
+rpath = false

ci/cw-check/Cargo.toml

@@ -40,14 +40,14 @@ function updateClient(
 
     clientState.VerifyClientMessage(clientMessage)
     // Validation END
-    
+
     // Execution START
     foundMisbehaviour := clientState.CheckForMisbehaviour(clientMessage)
     if foundMisbehaviour {
         clientState.UpdateStateOnMisbehaviour(clientMessage)
     }
-    else {    
-        clientState.UpdateState(clientMessage) 
+    else {
+        clientState.UpdateState(clientMessage)
     }
     // Execution END
 }
@@ -99,13 +99,13 @@ pub trait Host {
     /// An error type that can represent all host errors.
     type Error;
 
-    /// The Host's key-value store that must provide access to IBC paths. 
+    /// The Host's key-value store that must provide access to IBC paths.
     type KvStore: IbcStore<Self::Error>;
 
     /// An event logging facility.
     type EventLogger: EventLogger<Event=Event<DefaultIbcTypes>>;
 
-    /// Methods to access the store (ro & rw). 
+    /// Methods to access the store (ro & rw).
     fn store(&self) -> &Self::KvStore;
     fn store_mut(&mut self) -> &mut Self::KvStore;
 
@@ -373,11 +373,9 @@ trait ValidationContext {
     /// A hashing function for packet commitments
     fn hash(&self, value: Vec<u8>) -> Vec<u8>;
 
-    /// Returns the time when the client state for the given [`ClientId`] was updated with a header for the given [`Height`]
-    fn client_update_time(&self, client_id: &ClientId, height: Height) -> Result<Timestamp, Error>;
-
-    /// Returns the height when the client state for the given [`ClientId`] was updated with a header for the given [`Height`]
-    fn client_update_height(&self, client_id: &ClientId, height: Height) -> Result<Height, Error>;
+    /// Returns the time and height when the client state for the
+    /// given [`ClientId`] was updated with a header for the given [`Height`]
+    fn update_meta(&self, client_id: &ClientId, height: Height) -> Result<(Timestamp, Height), Error>;
 
     /// Returns a counter on the number of channel ids that have been created thus far.
     /// The value of this counter should increase only via method
@@ -427,22 +425,14 @@ trait ExecutionContext {
     fn increase_client_counter(&mut self);
 
     /// Called upon successful client update.
-    /// Implementations are expected to use this to record the specified time as the time at which
-    /// this update (or header) was processed.
-    fn store_update_time(
-        &mut self,
-        client_id: ClientId,
-        height: Height,
-        timestamp: Timestamp,
-    ) -> Result<(), Error>;
-
-    /// Called upon successful client update.
-    /// Implementations are expected to use this to record the specified height as the height at
-    /// at which this update (or header) was processed.
-    fn store_update_height(
+    ///
+    /// Implementations are expected to use this to record the specified time
+    /// and height as the time at which this update (or header) was processed.
+    fn store_update_meta(
         &mut self,
         client_id: ClientId,
         height: Height,
+        host_timestamp: Timestamp,
         host_height: Height,
     ) -> Result<(), Error>;
 
@@ -550,16 +540,11 @@ pub trait Host {
 
     /// Methods currently in `ClientKeeper`
     fn increase_client_counter(&mut self);
-    fn store_update_time(
-        &mut self,
-        client_id: ClientId,
-        height: Height,
-        timestamp: Timestamp,
-    ) -> Result<(), Error>;
-    fn store_update_height(
+    fn store_update_meta(
         &mut self,
         client_id: ClientId,
         height: Height,
+        host_timestamp: Timestamp,
         host_height: Height,
     ) -> Result<(), Error>;
 
@@ -574,8 +559,7 @@ pub trait Host {
     /// Methods currently in `ChannelReader`
     fn connection_channels(&self, cid: &ConnectionId) -> Result<Vec<(PortId, ChannelId)>, Error>;
     fn hash(&self, value: Vec<u8>) -> Vec<u8>;
-    fn client_update_time(&self, client_id: &ClientId, height: Height) -> Result<Timestamp, Error>;
-    fn client_update_height(&self, client_id: &ClientId, height: Height) -> Result<Height, Error>;
+    fn update_meta(&self, client_id: &ClientId, height: Height) -> Result<(Timestamp, Height), Error>;
     fn channel_counter(&self) -> Result<u64, Error>;
     fn max_expected_time_per_block(&self) -> Duration;
     fn block_delay(&self, delay_period_time: Duration) -> u64;
@@ -626,7 +610,7 @@ pub trait StoreSerde {
     /// Serialize to canonical binary representation
     fn serialize(self) -> Vec<u8>;
 
-    /// Deserialize from bytes 
+    /// Deserialize from bytes
     fn deserialize(value: &[u8]) -> Self;
 }
 

docs/architecture/adr-005-handlers-redesign.md

@@ -9,7 +9,7 @@ repository   = { workspace = true }
 keywords     = ["blockchain", "cosmos", "ibc", "transfer", "ics20"]
 readme       = "./../../README.md"
 description  = """
-    Maintained by `ibc-rs`, encapsulates essential ICS-20 Fungible Token Transfer data structures and 
+    Maintained by `ibc-rs`, encapsulates essential ICS-20 Fungible Token Transfer data structures and
     domain types, as specified in the Inter-Blockchain Communication (IBC) protocol. Designed for universal
     applicability to facilitate development and integration across diverse IBC-enabled projects.
 """
@@ -58,7 +58,7 @@ serde = [
 schema = [
     "dep:schemars",
     "ibc-core/schema",
-    "ibc-proto/json-schema", 
+    "ibc-proto/json-schema",
     "serde",
     "std"
 ]