diff --git a/.changelog/v0.48.0/summary.md b/.changelog/v0.48.0/summary.md index b865c8458..86454e131 100644 --- a/.changelog/v0.48.0/summary.md +++ b/.changelog/v0.48.0/summary.md @@ -2,14 +2,14 @@ In this release, we've undertaken a comprehensive overhaul of the **`ibc-rs`** repository, resulting in a strategic reorganization of the codebase. This restructuring dissects the implementation of each IBC specification, categorizing and situating them within relevant libraries. The primary objective -is to elevate ibc-rs practicality and enhance user flexibility by providing a +is to elevate `ibc-rs` practicality and enhance user flexibility by providing a more modular and composable experience. -Users now have the flexibility to choose from a spectrum of options. They can -opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`, +Users now have the flexibility to choose from a spectrum of dependencies. They +can opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`, `ibc-clients`, or `ibc-apps`. Alternatively, they can exercise fine-grained -control by selectively importing specific libraries. This can involve bringing -in an entire implemented IBC sub-module, like the `ibc-core-client` crate, or +control by selectively importing specific crates. This can involve bringing in +an entire implemented IBC sub-module, like the `ibc-core-client` crate, or importing only the associated data structures of a module, such as the `ibc-core-client-types` crate. diff --git a/CHANGELOG.md b/CHANGELOG.md index eeefd5b12..005143b9e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,14 +8,14 @@ In this release, we've undertaken a comprehensive overhaul of the **`ibc-rs`** repository, resulting in a strategic reorganization of the codebase. This restructuring dissects the implementation of each IBC specification, categorizing and situating them within relevant libraries. The primary objective -is to elevate ibc-rs practicality and enhance user flexibility by providing a +is to elevate `ibc-rs` practicality and enhance user flexibility by providing a more modular and composable experience. -Users now have the flexibility to choose from a spectrum of options. They can -opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`, +Users now have the flexibility to choose from a spectrum of dependencies. They +can opt to utilize the entire suite of meta-crates, such as `ibc`, `ibc-core`, `ibc-clients`, or `ibc-apps`. Alternatively, they can exercise fine-grained -control by selectively importing specific libraries. This can involve bringing -in an entire implemented IBC sub-module, like the `ibc-core-client` crate, or +control by selectively importing specific crates. This can involve bringing in +an entire implemented IBC sub-module, like the `ibc-core-client` crate, or importing only the associated data structures of a module, such as the `ibc-core-client-types` crate. diff --git a/ibc-core/ics02-client/context/Cargo.toml b/ibc-core/ics02-client/context/Cargo.toml index 06a23157b..5a5f1d467 100644 --- a/ibc-core/ics02-client/context/Cargo.toml +++ b/ibc-core/ics02-client/context/Cargo.toml @@ -7,7 +7,7 @@ rust-version = { workspace = true } license = { workspace = true } repository = { workspace = true } keywords = ["blockchain", "cosmos", "ibc"] -readme = "./../README.md" +readme = "./../../README.md" description = """ Maintaind by `ibc-rs`, contains essential APIs to interface with the host chain's store, enabling smooth client state transitions. Additionally, provides necessary traits for diff --git a/ibc-core/ics24-host/cosmos/Cargo.toml b/ibc-core/ics24-host/cosmos/Cargo.toml index f032f398f..ee57aab62 100644 --- a/ibc-core/ics24-host/cosmos/Cargo.toml +++ b/ibc-core/ics24-host/cosmos/Cargo.toml @@ -7,7 +7,7 @@ rust-version = { workspace = true } license = { workspace = true } repository = { workspace = true } keywords = ["blockchain", "cosmos", "ibc", "tendermint"] -readme = "./../README.md" +readme = "./../../README.md" description = """ Maintained by `ibc-rs`, contains Cosmos-specific helper traits and implementations to facilitate IBC integration, ensuring proper interaction with modules/components diff --git a/ibc-core/ics25-handler/src/lib.rs b/ibc-core/ics25-handler/src/lib.rs index 291dc76cd..203c98c2f 100644 --- a/ibc-core/ics25-handler/src/lib.rs +++ b/ibc-core/ics25-handler/src/lib.rs @@ -5,11 +5,10 @@ //! //! When processing a given message `M`, if any method in this library returns //! an error, the runtime is expected to rollback all state modifications made -//! to the context (e.g. -//! [`ExecutionContext`](ibc_core_host::ExecutionContext)) while processing -//! `M`. If a transaction on your blockchain contains multiple messages, then -//! typically the state modifications from all messages is expected to be rolled -//! back as well. +//! to the context (e.g. [`ExecutionContext`](ibc_core_host::ExecutionContext)) +//! while processing `M`. If the transaction containing `M` consists of multiple +//! messages, then typically the state modifications from all messages is +//! expected to be rolled back as well. #![no_std] #![forbid(unsafe_code)] #![cfg_attr(not(test), deny(clippy::unwrap_used))]