Skip to content

Commit 56c3bfb

Browse files
authored
Getting Started chapter (#168)
2 parents 31fffe6 + 14c4d6b commit 56c3bfb

File tree

5 files changed

+43
-3
lines changed

5 files changed

+43
-3
lines changed

src/pages/cw-multi-test.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ tags: ["multitest"]
44

55
import { Callout } from "nextra/components";
66

7+
[Rust and Cargo]: https://www.rust-lang.org/tools/install
78
[file an issue]: https://github.com/CosmWasm/cw-multi-test/issues
89

910
# MultiTest
@@ -28,7 +29,7 @@ overhead associated with network consensus and block production. This results in
2829
development cycle, allowing for quicker iterations and faster identification of issues, even before
2930
the smart contract is deployed on the blockchain.
3031

31-
While **`MultiTest`** is a blockchain **SIMULATOR**, it may happen, that the behavior of the real
32+
While **`MultiTest`** is a blockchain simulator, it may happen, that the behavior of the real
3233
blockchain might slightly differ in some edge cases. We strongly encourage you to [file an issue]
3334
with a detailed description of such use case to help us improve the **`MultiTest`**.
3435

@@ -40,5 +41,5 @@ By the end of these chapters, you will have a comprehensive understanding of how
4041
**`MultiTest`** for testing and debugging smart contracts in various scenarios.
4142

4243
<Callout>
43-
To successfully follow the upcoming chapters, a basic knowledge of Rust and Cargo is necessary.
44+
To successfully follow the upcoming chapters, a basic knowledge of [Rust and Cargo] is necessary.
4445
</Callout>

src/pages/cw-multi-test/_meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"installation": "Installation",
3-
"features": "Features"
3+
"features": "Features",
4+
"getting-started": "Getting started"
45
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
tags: ["multitest", "getting started"]
3+
---
4+
5+
import { Cards, Card } from "nextra/components";
6+
7+
# Getting started
8+
9+
This unit is designed to help you quickly become familiar with the fundamental aspects of testing
10+
smart contracts using **`MultiTest`**. It provides a practical example and best practices to ensure
11+
a smooth start with using **`MultiTest`** for testing smart contracts. In the following chapters,
12+
you will be:
13+
14+
- designing example [**counter**](getting-started/counter.mdx) smart contract,
15+
- [**writing tests**](getting-started/writing-tests.mdx) for the counter smart contract.
16+
17+
The example **counter** smart contract and all test cases are provided in two versions: one using
18+
pure CosmWasm libraries and the other using the Sylvia framework. The functionality of the
19+
**counter** smart contract is the same in both versions.
20+
21+
<Cards>
22+
<Card title="Counter" href="getting-started/counter" icon="" children="" />
23+
<Card title="Writing tests" href="getting-started/writing-tests" icon="" children="" />
24+
</Cards>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
tags: ["multitest", "getting started", "counter"]
3+
---
4+
5+
# Counter
6+
7+
(tbd)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
tags: ["multitest", "getting started", "writing tests"]
3+
---
4+
5+
# Writing tests
6+
7+
(tbd)

0 commit comments

Comments
 (0)