Fullständig dokumentation

src/pages/cw-multi-test.mdx

@@ -6,31 +6,35 @@ import { Callout } from "nextra/components";
 
 [file an issue]: https://github.com/CosmWasm/cw-multi-test/issues
 
-# Introduction
+# MultiTest
 
-**`MultiTest`** is a suite of testing tools designed to facilitate multi-contract interactions
-within the CosmWasm ecosystem. Its primary focus is on providing developers with a robust framework
-for testing complex smart contract interactions and operations involving various Cosmos modules.
+## Introduction
 
-<Callout type="info">
+**`MultiTest`** is a testing tool designed to facilitate multi-contract interactions within the
+CosmWasm ecosystem. Its primary focus is on providing developers with a robust framework for
+off-chain testing of complex smart contract interactions and operations involving various Cosmos
+modules.
+
+<Callout type="info" emoji="☉">
   **`MultiTest`** is a blockchain **SIMULATOR**, allowing tested smart contracts to interact as if
   they were operating on a real blockchain.
 </Callout>
 
-The most valuable advantage of using **`MultiTest`** is that it allows testing and debugging of
-smart contracts with access to the Rust source code, eliminating the need to run a complete
-blockchain node to begin designing the smart contract functionality. Additionally, **`MultiTest`**
+The most valuable advantages of using **`MultiTest`** is that it allows for testing and debugging
+smart contracts with access to the Rust source code and eliminates the need to run a complete
+blockchain node to begin designing the functionality of the contract. Additionally, **`MultiTest`**
 enables the execution of tests significantly faster than on a real blockchain, as it bypasses the
 overhead associated with network consensus and block production. This results in a more efficient
-development cycle, allowing for quicker iterations and faster identification of issues.
+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
 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`**.
 
 In the upcoming chapters, we provide detailed instructions on installing and getting started with
-**`MultiTest`**, writing unit tests for smart contracts, testing complex interactions between smart
-contracts and testing smart contract interactions with Cosmos modules.
+**`MultiTest`**, writing integration tests for smart contracts, testing complex interactions between
+smart contracts, and testing smart contract interactions with several Cosmos modules.
 
 By the end of these chapters, you will have a comprehensive understanding of how to use
 **`MultiTest`** for testing and debugging smart contracts in various scenarios.

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

@@ -1,4 +1,21 @@
 {
   "installation": "Installation",
-  "features": "Features"
+  "features": "Features",
+  "getting-started": "Getting started",
+  "app": "App",
+  "app-builder": "AppBuilder",
+  "contract": "Contract",
+  "contract-wrapper": "ContractWrapper",
+  "blocks": "Blocks",
+  "api": "API",
+  "addresses": "Addresses",
+  "storage": "Storage",
+  "bank": "Bank",
+  "staking": "Staking",
+  "distribution": "Distribution",
+  "governance": "Governance",
+  "stargate": "Stargate",
+  "wasm": "Wasm",
+  "custom": "Custom",
+  "ibc": "IBC"
 }

src/pages/cw-multi-test/addresses.mdx

@@ -0,0 +1,7 @@
+---
+tags: ["multitest", "addresses"]
+---
+
+# Addresses
+
+- `IntoAddr{:rust}`

src/pages/cw-multi-test/api.mdx

@@ -0,0 +1,17 @@
+---
+tags: ["multitest", "API"]
+---
+
+# API
+
+## Initialization with the default API
+
+(some description)
+
+- `App::default(){:rust}`
+- `app.api(){:rust}`
+
+```rust
+let app = App::default();
+app.api();
+```

src/pages/cw-multi-test/app-builder.mdx

@@ -0,0 +1,57 @@
+---
+tags: ["multitest", "AppBuilder"]
+---
+
+# `AppBuilder`
+
+## with_block
+
+```rust showLineNumbers {15} /with_block/
+use cosmwasm_std::{BlockInfo, Timestamp};
+use cw_multi_test::{no_init, AppBuilder};
+
+// create the chain builder
+let builder = AppBuilder::default();
+
+// prepare the custom block
+let block = BlockInfo {
+    height: 21,
+    time: Timestamp::from_nanos(1_571_797_419_879_305_544),
+    chain_id: "milky-way-testnet".to_string(),
+};
+
+// build the chain initialized with the custom block
+let app = builder.with_block(block).build(no_init);
+
+// get the current block properties
+let block = app.block_info();
+
+// now the block height is 21
+assert_eq!(21, block.height);
+
+// now the block timestamp is Wed Oct 23 2019 02:23:39 GMT+0000
+assert_eq!(1_571_797_419_879_305_544, block.time.nanos());
+
+// now the chain identifier is "milky-way-testnet"
+assert_eq!("milky-way-testnet", block.chain_id);
+```
+
+## with_api
+
+## with_storage
+
+## with_bank
+
+## with_staking
+
+## with_distribution
+
+## with_gov
+
+## with_stargate
+
+## with_wasm
+
+## new_custom
+
+## with_ibc

src/pages/cw-multi-test/app.mdx

@@ -0,0 +1,94 @@
+---
+tags: ["multitest", "App"]
+---
+
+# `App`
+
+The `App{:rust}` struct in **`MultiTest`** represents the blockchain simulator. Creating
+`App{:rust}` mimics the startup of a real-life blockchain within tests that utilize **`MultiTest`**.
+
+<br />
+
+<div
+  style={{
+    textAlign: "center",
+    fontSize: "4em",
+    fontWeight: "bold",
+    verticalAlign: "middle",
+    background: "#005DC70D",
+    borderRadius: "0.2em",
+  }}
+>
+  <div style={{ display: "inline-block", verticalAlign: "middle", color: "#9575CD" }}>App</div>
+  <div style={{ display: "inline-block", verticalAlign: "middle", fontWeight: "normal" }}>
+    &nbsp;=&nbsp;
+  </div>
+  <div style={{ display: "inline-block", verticalAlign: "middle" }}>
+    <div style={{ position: "relative", top: "0.1em", color: "#0D47A1" }}>Chain</div>
+    <div
+      style={{
+        fontSize: "0.4em",
+        fontWeight: "bold",
+        top: "-0.45em",
+        position: "relative",
+        color: "#1976D2",
+      }}
+    >
+      SIMULATOR
+    </div>
+  </div>
+</div>
+
+## `App::default`
+
+The most straightforward way to create the `App{:rust}` is by using the `default` method, which is
+the equivalent of calling the `new` constructor with an empty initialization callback.
+
+```rust showLineNumbers copy /default/
+use cw_multi_test::App;
+
+let app = App::default();
+```
+
+```rust showLineNumbers copy /new/
+use cw_multi_test::{no_init, App};
+
+let app = App::new(no_init);
+```
+
+In both cases, the newly created `App{:rust}` object simulates a blockchain with the default
+settings, as summarized in the table below:
+
+| Feature                      | Default implementation                                                                                                      |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| [Blocks](blocks)             | [`cosmwasm_std::mock_env().block{:rust}`](https://docs.rs/cosmwasm-std/latest/cosmwasm_std/testing/fn.mock_env.html)        |
+| [API](api)                   | [`cosmwasm_std::MockApi{:rust}`](https://docs.rs/cosmwasm-std/latest/cosmwasm_std/testing/struct.MockApi.html)              |
+| [Storage](storage)           | [`cosmwasm_std::MockStorage{:rust}`](https://docs.rs/cosmwasm-std/latest/cosmwasm_std/testing/type.MockStorage.html)        |
+| [Bank](bank)                 | [`BankKeeper{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.BankKeeper.html)                            |
+| [Staking](staking)           | [`StakeKeeper{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.StakeKeeper.html)                          |
+| [Distribution](distribution) | [`DistributionKeeper{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.DistributionKeeper.html)            |
+| [Governance](governance)     | [`GovFailingModule{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/type.GovFailingModule.html)                  |
+| [Stargate](stargate)         | [`StargateFailing{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.StargateFailing.html)                  |
+| [Wasm](wasm)                 | [`WasmKeeper{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.WasmKeeper.html)                            |
+| [Custom](custom)             | [`FailingModule<Empty, Empty, Empty>{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/struct.FailingModule.html) |
+| [IBC](ibc)                   | [`IbcFailingModule{:rust}`](https://docs.rs/cw-multi-test/latest/cw_multi_test/type.IbcFailingModule.html)                  |
+
+## `App::new`
+
+(todo)
+
+## Storing smart contract's code
+
+(todo)
+
+## Instantiating smart contract
+
+(todo)
+
+## Querying smart contract
+
+(todo)
+
+## Executing smart contract
+
+(todo)

src/pages/cw-multi-test/bank.mdx

@@ -0,0 +1,18 @@
+---
+tags: ["multitest", "bank"]
+---
+
+# Bank
+
+- `BankKeeper{:rust}` (default implementation)
+
+---
+
+- `BankMsg::Send{:rust}`
+- `BankMsg::Burn{:rust}`
+- `BankQuery::AllBalances{:rust}`
+- `BankQuery::Balance{:rust}`
+- `BankQuery::Supply{:rust}`
+- `BankQuery::DenomMetadata{:rust}`
+- `BankQuery::AllDenomMetadata{:rust}`
+- `BankSudo::Mint{:rust}`