R4R: Update genesis docs (#2833)

* Extend validator-setup.md
This commit is contained in:
Alessio Treglia 2018-11-26 17:21:09 +00:00 committed by Jack Zampolin
parent 7ec2b9a72b
commit 469b8eff6b
2 changed files with 111 additions and 10 deletions

View File

@ -103,6 +103,12 @@ curl https://raw.githubusercontent.com/cosmos/testnets/master/latest/genesis.jso
Note we use the `latest` directory in the [testnets repo](https://github.com/cosmos/testnets)
which contains details for the latest testnet. If you are connecting to a different testnet, ensure you get the right files.
To verify the correctness of the configuration run:
```bash
gaiad start
```
### Add Seed Nodes
Your node needs to know how to find peers. You'll need to add healthy seed nodes to `$HOME/.gaiad/config/config.toml`. The `testnets` repo contains links to the seed nodes for each testnet. If you are looking to join the running testnet please [check the repository for details](https://github.com/cosmos/testnets) on which nodes to use.

View File

@ -6,7 +6,7 @@ Information on how to join the current testnet (`genesis.json` file and seeds) i
Before setting up your validator node, make sure you've already gone through the [Full Node Setup](/docs/getting-started/full-node.md) guide.
## Running a Validator Node
## What is a Validator?
[Validators](/validators/overview.md) are responsible for committing new blocks to the blockchain through voting. A validator's stake is slashed if they become unavailable or sign blocks at the same height. Please read about [Sentry Node Architecture](/validators/validator-faq.md#how-can-validators-protect-themselves-from-denial-of-service-attacks) to protect your node from DDOS attacks and to ensure high-availability.
@ -14,7 +14,9 @@ Before setting up your validator node, make sure you've already gone through the
If you want to become a validator for the Hub's `mainnet`, you should [research security](/validators/security.md).
:::
### Create Your Validator
You may want to skip the next section if you have already [set up a full-node](/join-testnet.md).
## Create Your Validator
Your `cosmosvalconspub` can be used to create a new validator by staking tokens. You can find your validator pubkey by running:
@ -22,7 +24,7 @@ Your `cosmosvalconspub` can be used to create a new validator by staking tokens.
gaiad tendermint show-validator
```
Next, craft your `gaiacli tx stake create-validator` command:
Next, craft your `gaiad gentx` command:
::: warning Note
Don't use more `steak` thank you have! You can always get more by using the [Faucet](https://faucetcosmos.network/)!
@ -37,18 +39,111 @@ gaiacli tx stake create-validator \
--from=<key_name> \
--commission-rate="0.10" \
--commission-max-rate="0.20" \
--commission-max-change-rate="0.01"
--commission-max-change-rate="0.01"
```
__Note__: When specifying commission parameters, the `commission-max-change-rate`
is used to measure % _point_ change over the `commission-rate`. E.g. 1% to 2% is
a 100% rate increase, but only 1 percentage point.
__Note__: If unspecified, `consensus_pubkey` will default to the output of `gaiad tendermint show-validator`.
`key_name` is the name of the private key that will be used to sign the transaction.
## Participate in genesis as a validator
__Note__: This section only concerns validators that want to be in the genesis file. If the chain you want to validate is already live, skip this section.
__Note__: `Gaia-9002` and `Game of stakes` will not use this process. They will be bootsrapped using Tendermint seed validators. You will just need to use the [create-validator](#create-your-validator) command in order to join as a validator for these networks.
If you want to participate in genesis as a validator, you need to justify that you (or a delegator) have some stake at genesis, create one (or multiple) transaction to bond this stake to your validator address, and include this transaction in the genesis file.
We thus need to distinguish two cases:
- Case 1: You want to bond the initial stake from your validator's address.
- Case 2: You want to bond the initial stake from a delegator's address.
### Case 1: The initial stake comes from your validator's address
In this case, you will create a `gentx`:
```bash
gaiad gentx \
--amount <amount_of_delegation> \
--commission-rate <commission_rate> \
--commission-max-rate <commission_max_rate> \
--commission-max-change-rate <commission_max_change_rate> \
--pubkey <consensus_pubkey> \
--name <key_name>
```
__Note__: This command automatically store your `gentx` in `~/.gaiad/config/gentx` for it to be processed at genesis.
::: tip
Use `gaiacli tx stake create-validator -h` to get a list of all the available flags.
Consult `gaiad gentx --help` for more information on the flags defaults.
:::
### Edit Validator Description
A `gentx` is a JSON file carrying a self-delegation. All genesis transactions are collected by a `genesis coordinator` and validated against an initial `genesis.json`. Such initial `genesis.json` contains only a list of accounts and their coins. Once the transactions are processed, they are merged in the `genesis.json`'s `gentxs` field.
### Case 2: The initial stake comes from a delegator's address
In this case, you need both the signature of the validator and the delegator. Start by creating an unsigned `create-validator` transaction, and save it in a file called `unsignedValTx`:
```bash
gaiacli tx stake create-validator \
--amount=5steak \
--pubkey=$(gaiad tendermint show-validator) \
--moniker="choose a moniker" \
--chain-id=<chain_id> \
--from=<key_name> \
--commission-rate="0.10" \
--commission-max-rate="0.20" \
--commission-max-change-rate="0.01" \
--address-delegator="address of the delegator" \
--generate-only \
> unsignedValTx.json
```
Then, sign this `unsignedValTx` with your validator's private key, and save the output in a new file `signedValTx.json`:
```bash
gaiacli tx sign unsignedValTx.json --from=<validator_key_name> > signedValTx.json
```
Then, pass this file to the delegator, who needs to run the following command:
```bash
gaiacli tx sign signedValTx.json --from=<delegator_key_name> > gentx.json
```
This `gentx.json` needs to be included in the `~/.gaiad/config/gentx` folder on the validator's machine to be processed at genesis, just like in case 1 (except here it needs to be copied manually into the folder).
### Copy the Initial Genesis File and Process Genesis Transactions
Fetch the `genesis.json` file into `gaiad`'s config directory.
```bash
mkdir -p $HOME/.gaiad/config
curl https://raw.githubusercontent.com/cosmos/testnets/master/latest/genesis.json > $HOME/.gaiad/config/genesis.json
```
Note we use the `latest` directory in the [testnets repo](https://github.com/cosmos/testnets)
which contains details for the latest testnet. If you are connecting to a different testnet, ensure you get the right files.
You also need to fetch the genesis transactions of all the other genesis validators. For now there is no repository where genesis transactions can be submitted by validators, but this will as soon as we try out this feature in a testnet.
Once you've collected all genesis transactions in `~/.gaiad/config/gentx`, you can run:
```bash
gaiad collect-gentxs
```
The previous command will collect all genesis transactions and finalise `genesis.json`. To verify the correctness of the configuration and start the node run:
```bash
gaiad start
```
## Edit Validator Description
You can edit your validator's public description. This info is to identify your validator, and will be relied on by delegators to decide which validators to stake to. Make sure to provide input for every flag below, otherwise the field will default to empty (`--moniker` defaults to the machine name).
@ -72,7 +167,7 @@ __Note__: The `commission-rate` value must adhere to the following invariants:
% point change rate **per day**. In other words, a validator can only change
its commission once per day and within `commission-max-change-rate` bounds.
### View Validator Description
## View Validator Description
View the validator's information with this command:
@ -80,7 +175,7 @@ View the validator's information with this command:
gaiacli query stake validator <account_cosmos>
```
### Track Validator Signing Information
## Track Validator Signing Information
In order to keep track of a validator's signatures in the past you can do so by using the `signing-info` command:
@ -89,7 +184,7 @@ gaiacli query slashing signing-info <validator-pubkey>\
--chain-id=<chain_id>
```
### Unjail Validator
## Unjail Validator
When a validator is "jailed" for downtime, you must submit an `Unjail` transaction from the operator account in order to be able to get block proposer rewards again (depends on the zone fee distribution).
@ -99,7 +194,7 @@ gaiacli tx slashing unjail \
--chain-id=<chain_id>
```
### Confirm Your Validator is Running
## Confirm Your Validator is Running
Your validator is active if the following command returns anything: