cosmos-sdk/simapp/v2/README.md
2024-12-19 18:51:59 +00:00

123 lines
3.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
sidebar_position: 1
---
# `SimApp/v2`
SimApp is an application built using the Cosmos SDK for testing and educational purposes.
`SimApp/v2` demonstrate a runtime/v2, server/v2 and store/v2 wiring.
## Running testnets with `simdv2`
Except stated otherwise, all participants in the testnet must follow through with each step.
### 1. Download and Setup
Download the Cosmos SDK and unzip it. You can do this manually (via the GitHub UI) or with the git clone command.
```sh
git clone github.com/cosmos/cosmos-sdk.git
```
Next, run this command to build the `simdv2` binary in the `build` directory.
```sh
make build
```
Use the following command and skip all the next steps to configure your SimApp node:
```sh
make init-simapp-v2
```
If youve run `simd` in the past, you may need to reset your database before starting up a new testnet. You can do that with this command:
```sh
# you need to provide the moniker and chain ID
$ ./simdv2 init [moniker] --chain-id [chain-id]
```
The command should initialize a new working directory at the `~simappv2` location.
The `moniker` and `chain-id` can be anything but you need to use the same `chain-id` subsequently.
### 2. Create a New Key
Execute this command to create a new key.
```sh
./simdv2 keys add [key_name]
```
The command will create a new key with your chosen name.
⚠️ Save the output somewhere safe; youll need the address later.
### 3. Add Genesis Account
Add a genesis account to your testnet blockchain.
```sh
./simdv2 genesis add-genesis-account [key_name] [amount]
```
Where `key_name` is the same key name as before, and the `amount` is something like `10000000000000000000000000stake`.
### 4. Add the Genesis Transaction
This creates the genesis transaction for your testnet chain.
```sh
./simdv2 genesis gentx [key_name] [amount] --chain-id [chain-id]
```
The amount should be at least `1000000000stake`. When you start your node, providing too much or too little may result in errors.
### 5. Create the Genesis File
A participant must create the genesis file `genesis.json` with every participant's transaction.
You can do this by gathering all the Genesis transactions under `config/gentx` and then executing this command.
```sh
./simdv2 genesis collect-gentxs
```
The command will create a new `genesis.json` file that includes data from all the validators. The command will create a new `genesis.json` file, including data from all the validators
Once you've received the super genesis file, overwrite your original `genesis.json` file with
the new super `genesis.json`.
Modify your `config/config.toml` (in the simapp working directory) to include the other participants as
persistent peers:
```toml
# Comma-separated list of nodes to keep persistent connections to
persistent_peers = "[validator_address]@[ip_address]:[port],[validator_address]@[ip_address]:[port]"
```
You can find `validator_address` by executing:
```sh
./simdv2 comet show-node-id
```
The output will be the hex-encoded `validator_address`. The default `port` is 26656.
### 6. Start the Nodes
Finally, execute this command to start your nodes.
```sh
./simdv2 start
```
Now you have a small testnet that you can use to try out changes to the Cosmos SDK or CometBFT!
> ⚠️ NOTE: Sometimes, creating the network through the `collect-gents` will fail, and validators will start in a funny state (and then panic).
If this happens, you can try to create and start the network first
with a single validator and then add additional validators using a `create-validator` transaction.