Skip to content

Commit cb35fd8

Browse files
committed
Added some chapters from Wasmd.
1 parent c153d6f commit cb35fd8

File tree

8 files changed

+139
-0
lines changed

8 files changed

+139
-0
lines changed

docs/wasmd/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Wasmd",
3+
"position": 3,
4+
"link": {
5+
"type": "doc",
6+
"id": "wasmd"
7+
}
8+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Getting started",
3+
"position": 1,
4+
"link": {
5+
"type": "doc",
6+
"id": "getting-started"
7+
}
8+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Getting started
2+
3+
This part of the documentation describes how to set up wasmd, start a node, and interact with it
4+
using the CLI.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Run a node
6+
7+
For detailed instructions on running a node, please refer to
8+
[this tutorial](https://tutorials.cosmos.network/tutorials/3-run-node/).
9+
Below, we provide a quick setup script to get your node up and running.
10+
11+
:::warning
12+
13+
Make sure to remove the `.wasmd` folder before starting this setup. The `.wasmd` folder is usually
14+
located in your home directory and contains all the data related to the chain. Leaving it might
15+
cause conflicts or errors.
16+
17+
:::
18+
19+
## Setup node
20+
21+
Run the following script to initialize and configure your node:
22+
23+
```shell
24+
# Initialize the node with a moniker (name) and a specific chain ID
25+
wasmd init demo --chain-id=docs-chain-1
26+
27+
# Add key pairs for alice and bob accounts
28+
wasmd keys add alice --keyring-backend=test
29+
wasmd keys add bob --keyring-backend=test
30+
31+
# Add genesis accounts with initial balances
32+
wasmd genesis add-genesis-account alice "1000000000000stake" --keyring-backend=test
33+
wasmd genesis add-genesis-account bob "1000000000000stake" --keyring-backend=test
34+
35+
# Create a genesis transaction for the alice account, making alice a validator
36+
wasmd genesis gentx alice "250000000stake" --chain-id=docs-chain-1 --amount="250000000stake" --keyring-backend=test
37+
38+
# Collect genesis transactions to finalize the genesis file
39+
wasmd genesis collect-gentxs
40+
```
41+
42+
## Start node
43+
44+
To start the node, run the following command:
45+
46+
```shell
47+
wasmd start
48+
```
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Set up local environment
6+
7+
## Install Go
8+
9+
To build and install Wasmd, Go is required. If you haven't installed Go yet, you can set it up by
10+
visiting the [Go download and install page](https://go.dev/doc/install).
11+
12+
:::tip
13+
14+
The latest version of wasmd requires `go version v1.21`.
15+
16+
:::
17+
18+
19+
## Set up Wasmd
20+
21+
Clone the wasmd repository
22+
23+
```shell
24+
git clone https://github.com/CosmWasm/wasmd.git && cd wasmd
25+
```
26+
27+
Select the most stable version
28+
29+
```shell
30+
git checkout v0.52.0 # replace the v0.52.0 with the most stable version
31+
```
32+
33+
Install wasmd
34+
35+
```shell
36+
make install
37+
```
38+
39+
You can verify the version of Wasmd you have once it is installed:
40+
41+
```shell
42+
wasmd version
43+
```
44+
45+
:::warning
46+
47+
Running a node on Windows OS is not supported yet. However, you can use WSL (Windows Subsystem for
48+
Linux) to run a node on Windows. Alternatively, you can build a Wasmd client for Windows with:
49+
`make build-windows-client`.
50+
51+
:::
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Integration",
3+
"position": 2,
4+
"link": {
5+
"type": "doc",
6+
"id": "integration"
7+
}
8+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Integration
2+
3+
This part of the documentation describes how to integrate wasmd in your project.

docs/wasmd/wasmd.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Introduction
2+
3+
Wasmd is a Cosmos-SDK sample application that integrates the [x/wasm] module, providing full support
4+
for Wasm smart contracts while maintaining the standard features of a Cosmos-based blockchain.
5+
[x/wasm] is an essential module for developers looking to build Cosmos SDK-based blockchains where
6+
they can deploy, execute, and manage Wasm smart contracts. In this section you will learn how to set
7+
up **wasmd** and integrate [x/wasm] in your blockchain.
8+
9+
[x/wasm]: https://github.com/CosmWasm/wasmd/tree/main/x/wasm

0 commit comments

Comments
 (0)