Skip to content

Commit 98bab9f

Browse files
committed
Added initial MultiTest chapter.
1 parent 2e32764 commit 98bab9f

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

docs/multi-test/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "MultiTest",
3+
"position": 7,
4+
"link": {
5+
"type": "doc",
6+
"id": "introduction"
7+
}
8+
}

docs/multi-test/introduction.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Introduction
2+
3+
**MultiTest** is a testing tool designed to facilitate multi-contract interactions within the
4+
CosmWasm ecosystem. Its primary focus is on providing developers with a robust framework for
5+
off-chain testing of complex smart contract interactions and operations involving various Cosmos
6+
modules.
7+
8+
:::info
9+
10+
**MultiTest** is a _**blockchain simulator**_, allowing tested smart contracts to interact
11+
as if they were operating on a real blockchain.
12+
13+
:::
14+
15+
The most valuable advantages of using **MultiTest** is that it allows for testing and debugging
16+
smart contracts with access to the Rust source code and eliminates the need to run a complete
17+
blockchain node to begin designing the functionality of the contract. Additionally, **MultiTest**
18+
enables the execution of tests significantly faster than on a real blockchain, as it bypasses the
19+
overhead associated with network consensus and block production. This results in a more efficient
20+
development cycle, allowing for quicker iterations and faster identification of issues, even before
21+
the smart contract is deployed on the blockchain.
22+
23+
While **MultiTest** is a blockchain simulator, it may happen, that the behavior of the real
24+
blockchain might slightly differ in some edge cases. We strongly encourage you to [file an issue]
25+
with a detailed description of such use case to help us improve the **MultiTest**.
26+
27+
In the upcoming chapters, we provide detailed instructions on installing and getting started with
28+
**MultiTest**, writing integration tests for smart contracts, testing complex interactions between
29+
smart contracts, and testing smart contract interactions with several Cosmos modules.
30+
31+
By the end of these chapters, you will have a comprehensive understanding of how to use
32+
**MultiTest** for testing and debugging smart contracts in various scenarios.
33+
34+
:::tip
35+
36+
To successfully follow the upcoming chapters, a basic knowledge of [Rust and Cargo] is necessary.
37+
38+
:::
39+
40+
[Rust and Cargo]: https://www.rust-lang.org/tools/install
41+
[file an issue]: https://github.com/CosmWasm/cw-multi-test/issues

0 commit comments

Comments
 (0)