From 35ca592e619dbad4a77888fe499aa72ae358b6fb Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 12:28:35 +0100 Subject: [PATCH 1/7] Updates. --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9c0483bc..deec7bc7 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,42 @@ -## CosmWasm MultiTest README +# CosmWasm MultiTest ## Introduction -CosmWasm `MultiTest` is a dynamic suite of testing tools designed for facilitating multi-contract -interactions within the CosmWasm ecosystem. Its primary focus is on providing developers -with a robust framework for simulating complex contract interactions and bank operations. -Currently in the alpha stage, CosmWasm MultiTest is primarily used internally for testing cw-plus contracts. +**CosmWasm MultiTest** is a suite of testing tools designed for facilitating multi-contract +interactions within the [CosmWasm](https://github.com/CosmWasm) ecosystem. +Its primary focus is on providing developers with a robust framework for simulating +complex contract interactions and bank operations. Currently, **CosmWasm MultiTest** +is in the _alpha_ stage, and primarily used internally for testing +[cw-plus](https://github.com/CosmWasm/cw-plus) contracts. ## Warning and Current Status -## Alpha Stage Caution -CosmWasm MultiTest is currently in its alpha development phase, primarily intended for internal use. +### Alpha Stage Caution + +**CosmWasm MultiTest** is currently in its alpha development phase, primarily intended for internal use. Developers are advised to use this framework cautiously, understanding that it is still undergoing -significant development and refinement. The current version lacks API stability, -which is a crucial aspect to consider for projects that require long-term consistency and dependability. +significant development and refinement. **The current version's API is not stable yet**. -## Internal Use and Refinement +### Internal Use and Refinement -Internally, the CosmWasm MultiTest framework is an essential tool for the testing of cw-plus contracts. -Its development is focused on ensuring the reliability and security of these contracts. -The team is actively working on refactoring and enhancing CosmWasm MultiTest to provide a -more stable and feature-rich version for broader community use in the future. +Internally, the **CosmWasm MultiTest** framework is an essential tool for the +testing of cw-plus contracts. Its development is focused on ensuring the reliability +and security of these contracts. The team is actively working on refactoring and enhancing +**CosmWasm MultiTest** to provide a more stable and feature-rich version for broader +community use in the future. -## Framework Capabilities +### Framework Capabilities -CosmWasm `MultiTest` enables comprehensive unit testing, including scenarios where contracts +**CosmWasm MultiTest** enables comprehensive unit testing, including scenarios where contracts call other contracts and interact with the bank module. Its current implementation effectively handles these interactions, providing a realistic testing environment for contract developers. -The team is committed to extending CosmWasm MultiTest's capabilities, making it a versatile tool -for various blockchain interaction tests. +The team is committed to extending **CosmWasm MultiTest**'s capabilities, making it a versatile tool +for various blockchain interaction tests. ## Conclusion -CosmWasm MultiTest stands as a vital development tool in the CosmWasm ecosystem, especially for -developers engaged in building complex decentralized applications. As the framework evolves, it is -poised to become an even more integral part of the CosmWasm development toolkit. Users are encouraged -to stay updated with its progress and contribute to its development. +**CosmWasm MultiTest** stands as a vital development tool in +the [CosmWasm](https://github.com/CosmWasm) ecosystem, especially for developers engaged +in building complex decentralized applications. As the framework evolves, it is poised to become +an even more integral part of the [CosmWasm](https://github.com/CosmWasm) development toolkit. +Users are encouraged to stay updated with its progress and contribute to its development. From 81df954d9f64f5ab29f10ce45d19bdc93acc38ac Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 12:30:16 +0100 Subject: [PATCH 2/7] Updates. --- Cargo.toml | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 11b988a1..14f879ff 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "cw-multi-test" version = "0.18.1" authors = ["Ethan Frey "] edition = "2021" -description = "Test helpers for multi-contract interactions" +description = "Testing tools for multi-contract interactions" license = "Apache-2.0" repository = "https://github.com/CosmWasm/cw-multi-test" homepage = "https://cosmwasm.com" diff --git a/README.md b/README.md index deec7bc7..3d5c584e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # CosmWasm MultiTest +**Testing tools for multi-contract interactions** + ## Introduction **CosmWasm MultiTest** is a suite of testing tools designed for facilitating multi-contract From 39599528494761b6b33963c16e96bf486c6ebf72 Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 12:53:50 +0100 Subject: [PATCH 3/7] Updates. --- LICENSE | 2 +- NOTICE | 15 +++++++++++++++ README.md | 23 +++++++++++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 NOTICE diff --git a/LICENSE b/LICENSE index d6456956..f9d983f9 100644 --- a/LICENSE +++ b/LICENSE @@ -187,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright (C) 2021-2023 Confio GmbH Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..ad7061c3 --- /dev/null +++ b/NOTICE @@ -0,0 +1,15 @@ +cw-multi-test: Testing tools for multi-contract interactions + +Copyright (C) 2021-2023 Confio GmbH + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md index 3d5c584e..a23bb048 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ # CosmWasm MultiTest +[![cw-multi-test on crates.io][crates-badge]][crates-url] +[![docs][docs-badge]][docs-url] +[![codecov][codecov-badge]][codecov-url] +[![license][apache-badge]][apache-url] + +[crates-badge]: https://img.shields.io/crates/v/cw-multi-test.svg +[crates-url]: https://crates.io/crates/cw-multi-test +[docs-badge]: https://docs.rs/cw-multi-test/badge.svg +[docs-url]: https://docs.rs/cw-multi-test +[codecov-badge]: https://codecov.io/gh/CosmWasm/cw-multi-test/branch/main/graph/badge.svg?token=IYY72ZVS3X +[codecov-url]: https://codecov.io/gh/CosmWasm/cw-multi-test +[apache-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg +[apache-url]: LICENSE +[notice-url]: NOTICE + **Testing tools for multi-contract interactions** ## Introduction @@ -42,3 +57,11 @@ the [CosmWasm](https://github.com/CosmWasm) ecosystem, especially for developers in building complex decentralized applications. As the framework evolves, it is poised to become an even more integral part of the [CosmWasm](https://github.com/CosmWasm) development toolkit. Users are encouraged to stay updated with its progress and contribute to its development. + +## License + +Licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) +(see [LICENSE][apache-url] and [NOTICE][notice-url]). + +Any contribution intentionally submitted for inclusion in this crate by you, +shall be licensed as above, without any additional terms or conditions. From c9fe8feb22f8596cfd63ae92793c14cfb3df01d7 Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 13:05:23 +0100 Subject: [PATCH 4/7] Updates. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a23bb048..75906a59 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ [apache-url]: LICENSE [notice-url]: NOTICE -**Testing tools for multi-contract interactions** +Testing tools for multi-contract interactions ## Introduction From 6553935e0825e0291280b7a5fd1b6acc6e442ce6 Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 13:05:59 +0100 Subject: [PATCH 5/7] Updates. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75906a59..98375802 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ [apache-url]: LICENSE [notice-url]: NOTICE -Testing tools for multi-contract interactions +### Testing tools for multi-contract interactions ## Introduction From d1b319de9c4106476493e3a2b9ce4c753812532e Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Fri, 24 Nov 2023 13:06:22 +0100 Subject: [PATCH 6/7] Updates. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98375802..08701df4 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ [apache-url]: LICENSE [notice-url]: NOTICE -### Testing tools for multi-contract interactions +> **Testing tools for multi-contract interactions** ## Introduction From cece84d44801de392f73e64c7c6d20b60c5408ac Mon Sep 17 00:00:00 2001 From: Dariusz Depta Date: Mon, 27 Nov 2023 11:22:30 +0100 Subject: [PATCH 7/7] Applied remarks after review. --- LICENSE | 2 +- README.md | 8 +------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index f9d983f9..d6456956 100644 --- a/LICENSE +++ b/LICENSE @@ -187,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright (C) 2021-2023 Confio GmbH + Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 08701df4..db9c5d4f 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,7 @@ complex contract interactions and bank operations. Currently, **CosmWasm MultiTe is in the _alpha_ stage, and primarily used internally for testing [cw-plus](https://github.com/CosmWasm/cw-plus) contracts. -## Warning and Current Status - -### Alpha Stage Caution - -**CosmWasm MultiTest** is currently in its alpha development phase, primarily intended for internal use. -Developers are advised to use this framework cautiously, understanding that it is still undergoing -significant development and refinement. **The current version's API is not stable yet**. +## Current Status ### Internal Use and Refinement