diff --git a/CHANGELOG.md b/CHANGELOG.md index 54b92f62..b16a805f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## v0.4.2 (2024-01-28) + +### Changes + +- Added inline documentation to the enum variant inserted by the proc macro introduced in `v0.4.1`. (https://github.com/srdtrk/cw-ica-controller/pull/66) + ## v0.4.1 (2024-01-27) ### Features diff --git a/Cargo.lock b/Cargo.lock index fa70028f..c6cc2ac2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -296,7 +296,7 @@ dependencies = [ [[package]] name = "cw-ica-controller" -version = "0.4.1" +version = "0.4.2" dependencies = [ "base64 0.13.1", "cosmos-sdk-proto", @@ -318,9 +318,9 @@ dependencies = [ [[package]] name = "cw-ica-controller-derive" -version = "0.4.1" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1d71896e4c9b3825f9498af166af4d5527f53bb5e788e339cf3812154aac986d" +checksum = "905f3948e7af9264095f7cd596cf519d72f9494337f8953504a4c01874979151" dependencies = [ "proc-macro2", "quote", diff --git a/Cargo.toml b/Cargo.toml index 047b0fd1..ea92d507 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "cw-ica-controller" -version = "0.4.1" +version = "0.4.2" authors = ["srdtrk "] edition = "2021" description = "This is a CosmWasm implementation of an ICS-27 interchain accounts controller." @@ -58,7 +58,7 @@ thiserror = "1.0.50" cosmos-sdk-proto = { version = "0.20.0", default-features = false, features = ["cosmwasm"] } semver = "1.0" cw-ownable = "0.5.1" -cw-ica-controller-derive = "0.4.1" +cw-ica-controller-derive = "0.4.2" [dev-dependencies] base64 = "0.13.1" diff --git a/derive/Cargo.toml b/derive/Cargo.toml index 8e0484cf..272083b1 100644 --- a/derive/Cargo.toml +++ b/derive/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "cw-ica-controller-derive" authors = ["srdtrk "] -version = "0.4.1" +version = "0.4.2" edition = "2021" description = "This crate contains macros for deriving cw-ica-controller interfaces." repository = "https://github.com/srdtrk/cw-ica-controller" diff --git a/derive/src/lib.rs b/derive/src/lib.rs index 55dbfa3a..00c49010 100644 --- a/derive/src/lib.rs +++ b/derive/src/lib.rs @@ -87,6 +87,9 @@ pub fn ica_callback_execute(metadata: TokenStream, input: TokenStream) -> TokenS input, quote! { enum Right { + /// The callback message from `cw-ica-controller`. + /// The handler for this variant should verify that this message comes from an + /// expected legitimate source. ReceiveIcaCallback(::cw_ica_controller::types::callbacks::IcaControllerCallbackMsg), } } diff --git a/testing/contracts/callback-counter/Cargo.lock b/testing/contracts/callback-counter/Cargo.lock index 6ec88a20..5209c643 100644 --- a/testing/contracts/callback-counter/Cargo.lock +++ b/testing/contracts/callback-counter/Cargo.lock @@ -250,7 +250,7 @@ dependencies = [ [[package]] name = "cw-ica-controller" -version = "0.4.1" +version = "0.4.2" dependencies = [ "cosmos-sdk-proto", "cosmwasm-schema", @@ -268,9 +268,9 @@ dependencies = [ [[package]] name = "cw-ica-controller-derive" -version = "0.4.1" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1d71896e4c9b3825f9498af166af4d5527f53bb5e788e339cf3812154aac986d" +checksum = "905f3948e7af9264095f7cd596cf519d72f9494337f8953504a4c01874979151" dependencies = [ "proc-macro2", "quote", diff --git a/testing/contracts/callback-counter/src/msg.rs b/testing/contracts/callback-counter/src/msg.rs index 1f00fea4..bfa905b8 100644 --- a/testing/contracts/callback-counter/src/msg.rs +++ b/testing/contracts/callback-counter/src/msg.rs @@ -5,7 +5,9 @@ use cw_ica_controller::helpers::ica_callback_execute; pub struct InstantiateMsg {} #[ica_callback_execute] +#[deny(missing_docs)] #[cw_serde] +/// This is the execute message of the contract. pub enum ExecuteMsg {} #[cw_serde] diff --git a/testing/contracts/cw-ica-owner/Cargo.lock b/testing/contracts/cw-ica-owner/Cargo.lock index 385a8214..a492e38f 100644 --- a/testing/contracts/cw-ica-owner/Cargo.lock +++ b/testing/contracts/cw-ica-owner/Cargo.lock @@ -253,7 +253,7 @@ dependencies = [ [[package]] name = "cw-ica-controller" -version = "0.4.1" +version = "0.4.2" dependencies = [ "cosmos-sdk-proto", "cosmwasm-schema", @@ -271,9 +271,9 @@ dependencies = [ [[package]] name = "cw-ica-controller-derive" -version = "0.4.1" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1d71896e4c9b3825f9498af166af4d5527f53bb5e788e339cf3812154aac986d" +checksum = "905f3948e7af9264095f7cd596cf519d72f9494337f8953504a4c01874979151" dependencies = [ "proc-macro2", "quote",