-
Notifications
You must be signed in to change notification settings - Fork 586
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[update]: refactored README for interactivity and readability
Updated the readme for interactivity (copying the commands) and readability (gradual process view).
- Loading branch information
Showing
1 changed file
with
110 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,110 @@ | ||
# simapp | ||
|
||
simapp is an application built using the Cosmos SDK for testing and educational purposes. | ||
|
||
## Running testnets with `simd` | ||
|
||
If you want to spin up a quick testnet with your friends, you can follow these steps. | ||
Unless otherwise noted, every step must be done by everyone who wants to participate | ||
in this testnet. | ||
|
||
1. `$ make build`. This will build the `simd` binary and install it in your Cosmos SDK repo, | ||
inside a new `build` directory. The following instructions are run from inside | ||
that directory. | ||
2. If you've run `simd` before, you may need to reset your database before starting a new | ||
testnet: `$ ./simd unsafe-reset-all` | ||
3. `$ ./simd init [moniker]`. This will initialize a new working directory, by default at | ||
`~/.simapp`. You need a provide a "moniker," but it doesn't matter what it is. | ||
4. `$ ./simd keys add [key_name]`. This will create a new key, with a name of your choosing. | ||
Save the output of this command somewhere; you'll need the address generated here later. | ||
5. `$ ./simd add-genesis-account $(simd keys show [key_name] -a) [amount]`, where `key_name` | ||
is the same key name as before; and `amount` is something like `10000000000000000000000000stake`. | ||
6. `$ ./simd gentx [key_name] [amount] --chain-id [chain-id]`. This will create the | ||
genesis transaction for your new chain. | ||
7. Now, one person needs to create the genesis file `genesis.json` using the genesis transactions | ||
from every participant, by gathering all the genesis transactions under `config/gentx` and then | ||
calling `./simd collect-gentxs`. This will create a new `genesis.json` file that includes data | ||
from all the validators (we sometimes call it the "super genesis file" to distinguish it from | ||
single-validator genesis files). | ||
8. Once you've received the super genesis file, overwrite your original `genesis.json` file with | ||
the new super `genesis.json`. | ||
9. Modify your `config/config.toml` (in the simapp working directory) to include the other participants as | ||
persistent peers: | ||
|
||
```text | ||
# 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 running `./simd tendermint show-node-id`. (It will be hex-encoded.) | ||
By default, `port` is 26656. | ||
10. Now you can start your nodes: `$ ./simd start`. | ||
|
||
Now you have a small testnet that you can use to try out changes to the Cosmos SDK or Tendermint! | ||
|
||
NOTE: Sometimes creating the network through the `collect-gentxs` 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. | ||
# `SimApp` | ||
|
||
`SimApp` is a CLI application built using the Cosmos SDK for testing and educational purposes. | ||
|
||
## Running Testnets with `simd` | ||
|
||
Want to spin up a quick testnet with your friends? Follow these steps. Unless 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 `simd` 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 | ||
``` | ||
|
||
If you've 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 | ||
$ ./simd init [moniker] --chain-id [chain-id] | ||
``` | ||
|
||
The command should initialize a new working directory at the `~simapp` location. | ||
The `moniker` and `chain-id` can be anything, but you must use the same `chain-id` subsequently. | ||
|
||
### 2. Create a New Key | ||
|
||
Execute this command to create a new key: | ||
|
||
```sh | ||
./simd keys add [key_name] | ||
``` | ||
|
||
⚠️ The command will create a new key with your chosen name. | ||
Save the output somewhere safe; you'll need the address later. | ||
|
||
### 3. Add Genesis Account | ||
|
||
Add a genesis account to your testnet blockchain: | ||
|
||
```sh | ||
$ ./simd 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 | ||
$ ./simd genesis gentx [key_name] [amount] --chain-id [chain-id] | ||
``` | ||
|
||
The amount should be at least `1000000000stake`. Providing too much or too little may result in errors when you start your node. | ||
|
||
### 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 | ||
$ ./simd genesis collect-gentxs | ||
``` | ||
|
||
The command will create a new `genesis.json` file that includes data from all the validators. We sometimes call this the "super genesis file" to distinguish it from single-validator genesis files. | ||
|
||
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: | ||
|
||
``` | ||
# 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 | ||
$ ./simd 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 | ||
$ ./simd 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-gentxs` 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. |