From a9150b61cde37018ea6144138044d1a0d0f9c0f4 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:36:13 +0300 Subject: [PATCH 01/11] docs: add crate-level documentation with CosmWasm overview and docs link --- packages/vm/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/vm/src/lib.rs b/packages/vm/src/lib.rs index df26edbcf4..78386c5a1f 100644 --- a/packages/vm/src/lib.rs +++ b/packages/vm/src/lib.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate provides VM bindings to run CosmWasm contracts. +//! +//! For more information, see: + mod backend; mod cache; mod calls; From c0c317de42f31007dbad9a1fb2fa12d603f3867c Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:36:32 +0300 Subject: [PATCH 02/11] Update main.rs --- packages/check/src/main.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/check/src/main.rs b/packages/check/src/main.rs index 57c29c504b..eb8cdf26cb 100644 --- a/packages/check/src/main.rs +++ b/packages/check/src/main.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This binary provides a CLI tool for verifying CosmWasm smart contracts before uploading to a blockchain. +//! +//! For more information, see: + use std::collections::HashSet; use std::fs::File; use std::io::Read; From 8ff37454ce29808e0c91821f34bcf1268a9509b6 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:36:52 +0300 Subject: [PATCH 03/11] Update lib.rs --- packages/cw-schema-derive/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/cw-schema-derive/src/lib.rs b/packages/cw-schema-derive/src/lib.rs index 13f3cf46f4..8deba52c04 100644 --- a/packages/cw-schema-derive/src/lib.rs +++ b/packages/cw-schema-derive/src/lib.rs @@ -1,3 +1,8 @@ +//! Derive macros for cw-schema. For internal use only. +//! +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! For more information, see: + mod expand; macro_rules! bail { From baeaf43f7d2056d8e2740f8a3d3616f1858795e6 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:37:15 +0300 Subject: [PATCH 04/11] Update lib.rs --- packages/cw-schema/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/cw-schema/src/lib.rs b/packages/cw-schema/src/lib.rs index 406c6b1d56..83dfdc9a3e 100644 --- a/packages/cw-schema/src/lib.rs +++ b/packages/cw-schema/src/lib.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate is a dependency for CosmWasm contracts to generate schema files for their messages. +//! +//! For more information, see: + #![no_std] extern crate alloc; From da7f29953ad149fa54bc54b6d35ae9b1f2fb7a3e Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:37:32 +0300 Subject: [PATCH 05/11] Update lib.rs --- packages/derive/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/derive/src/lib.rs b/packages/derive/src/lib.rs index 560e13afdb..661167b769 100644 --- a/packages/derive/src/lib.rs +++ b/packages/derive/src/lib.rs @@ -1,3 +1,7 @@ +//! Derive macros for CosmWasm contract development. For internal use only. Do not use directly. +//! +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! For more information, see: use proc_macro2::TokenStream; use quote::{format_ident, quote, ToTokens}; use std::env; From 2ed5801d019aafd8f42452706eb0f53ee9000e69 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:37:48 +0300 Subject: [PATCH 06/11] Update lib.rs --- packages/schema-derive/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/schema-derive/src/lib.rs b/packages/schema-derive/src/lib.rs index 187a67cac3..ae783d1628 100644 --- a/packages/schema-derive/src/lib.rs +++ b/packages/schema-derive/src/lib.rs @@ -1,3 +1,7 @@ +//! Derive macros for cosmwasm-schema. For internal use only. +//! +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! For more information, see: mod cw_serde; mod error; mod generate_api; From 24ebb26db71239f0590527b75eae634386d7add8 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:38:08 +0300 Subject: [PATCH 07/11] Update lib.rs --- packages/schema/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/schema/src/lib.rs b/packages/schema/src/lib.rs index 36698f8879..e47e4239e5 100644 --- a/packages/schema/src/lib.rs +++ b/packages/schema/src/lib.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate is a dev-dependency for CosmWasm contracts to generate JSON Schema files. +//! +//! For more information, see: + mod casing; mod export; mod idl; From 448b12d45c20d742f11904c0d3bd5a974918d023 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:38:26 +0300 Subject: [PATCH 08/11] Update lib.rs --- packages/crypto/src/lib.rs | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/packages/crypto/src/lib.rs b/packages/crypto/src/lib.rs index d03256a615..cc8ae5c292 100644 --- a/packages/crypto/src/lib.rs +++ b/packages/crypto/src/lib.rs @@ -1,7 +1,12 @@ -//! The crypto crate is intended to be used in internal crates / utils. -//! Please don't use any of these types directly, as -//! they might change frequently, or be removed in the future. -//! This crate does not adhere to semantic versioning. +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate implements cryptography-related functions for CosmWasm contracts and internal crates. +//! +//! For more information, see: + +// The crypto crate is intended to be used in internal crates / utils. +// Please don't use any of these types directly, as +// they might change frequently, or be removed in the future. +// This crate does not adhere to semantic versioning. extern crate alloc; From 311aab6eccffce9f7629279ae3efc475798a10c2 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:38:41 +0300 Subject: [PATCH 09/11] Update lib.rs --- packages/core/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/core/src/lib.rs b/packages/core/src/lib.rs index 75f2e6dc17..f6621a083d 100644 --- a/packages/core/src/lib.rs +++ b/packages/core/src/lib.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate contains components of cosmwasm-std that can be used in no_std environments. +//! +//! For more information, see: + #![no_std] mod crypto; From 6d6787b535caaca2cc2b802a1e728ddfb49e4098 Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:39:01 +0300 Subject: [PATCH 10/11] Update lib.rs --- packages/std/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/std/src/lib.rs b/packages/std/src/lib.rs index a7509507b1..d1a53640e3 100644 --- a/packages/std/src/lib.rs +++ b/packages/std/src/lib.rs @@ -1,3 +1,8 @@ +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! This crate provides the standard library for Wasm-based smart contracts on Cosmos blockchains. +//! +//! For more information, see: + #[cfg(not(feature = "std"))] core::compile_error!( r#"Please enable `cosmwasm-std`'s `std` feature, as we might move existing functionality to that feature in the future. From ea1056fccfbf3b73c0a0d6e24068967924385cae Mon Sep 17 00:00:00 2001 From: GarmashAlex Date: Thu, 26 Jun 2025 12:39:20 +0300 Subject: [PATCH 11/11] Update lib.rs --- packages/vm-derive/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/vm-derive/src/lib.rs b/packages/vm-derive/src/lib.rs index bdbb93846f..58568a5a64 100644 --- a/packages/vm-derive/src/lib.rs +++ b/packages/vm-derive/src/lib.rs @@ -1,3 +1,8 @@ +//! Derive macros for cosmwasm-vm. For internal use only. No stability guarantees. +//! +//! CosmWasm is a smart contract platform for the Cosmos ecosystem. +//! For more information, see: + mod hash_function; macro_rules! maybe {