Skip to content

Commit

Permalink
Getting Started chapter (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
DariuszDepta authored Oct 21, 2024
2 parents 31fffe6 + 14c4d6b commit 56c3bfb
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 3 deletions.
5 changes: 3 additions & 2 deletions src/pages/cw-multi-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ tags: ["multitest"]

import { Callout } from "nextra/components";

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

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

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

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

<Callout>
To successfully follow the upcoming chapters, a basic knowledge of Rust and Cargo is necessary.
To successfully follow the upcoming chapters, a basic knowledge of [Rust and Cargo] is necessary.
</Callout>
3 changes: 2 additions & 1 deletion src/pages/cw-multi-test/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"installation": "Installation",
"features": "Features"
"features": "Features",
"getting-started": "Getting started"
}
24 changes: 24 additions & 0 deletions src/pages/cw-multi-test/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
tags: ["multitest", "getting started"]
---

import { Cards, Card } from "nextra/components";

# Getting started

This unit is designed to help you quickly become familiar with the fundamental aspects of testing
smart contracts using **`MultiTest`**. It provides a practical example and best practices to ensure
a smooth start with using **`MultiTest`** for testing smart contracts. In the following chapters,
you will be:

- designing example [**counter**](getting-started/counter.mdx) smart contract,
- [**writing tests**](getting-started/writing-tests.mdx) for the counter smart contract.

The example **counter** smart contract and all test cases are provided in two versions: one using
pure CosmWasm libraries and the other using the Sylvia framework. The functionality of the
**counter** smart contract is the same in both versions.

<Cards>
<Card title="Counter" href="getting-started/counter" icon="" children="" />
<Card title="Writing tests" href="getting-started/writing-tests" icon="" children="" />
</Cards>
7 changes: 7 additions & 0 deletions src/pages/cw-multi-test/getting-started/counter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
tags: ["multitest", "getting started", "counter"]
---

# Counter

(tbd)
7 changes: 7 additions & 0 deletions src/pages/cw-multi-test/getting-started/writing-tests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
tags: ["multitest", "getting started", "writing tests"]
---

# Writing tests

(tbd)

0 comments on commit 56c3bfb

Please sign in to comment.