Skip to content

Commit

Permalink
Merge pull request #103 from CosmWasm/costa2400-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
DariuszDepta authored Nov 24, 2023
2 parents 712521e + 093430f commit 332071f
Showing 1 changed file with 31 additions and 13 deletions.
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,38 @@
# CosmWasm MultiTest
## CosmWasm MultiTest README

## Overview
## Introduction

**CosmWasm MultiTest** is a suite of test helpers for multi-contract interactions.
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.

## Warning
## Warning and Current Status
## Alpha Stage Caution

**CosmWasm MultiTest** is currently in **alpha** stage, designed generally for internal use only.
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.

**`Use at your own risk`**
## Internal Use and Refinement

Internally, **CosmWasm MultiTest** is used for testing cw-plus contracts.
We have no API stability yet. We are working on refactoring it,
and will expose a more refined version for use in other contracts.
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.

**CosmWasm MultiTest** can be used to run unit tests with contracts calling contracts,
and calling in and out of bank. **CosmWasm MultiTest** works with contracts and bank currently.
We are working on making it more extensible for more handlers,
including custom messages/queries, as well as IBC.
## Framework Capabilities

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.

## 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.

0 comments on commit 332071f

Please sign in to comment.