Skip to content

Commit

Permalink
Update docs to reflect changes from #2728
Browse files Browse the repository at this point in the history
  • Loading branch information
jackzampolin authored and zramsay committed Nov 13, 2018
1 parent bf63824 commit 5a671e7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
54 changes: 27 additions & 27 deletions docs/gaia/gaiacli.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,21 +192,21 @@ On the upcoming mainnet, you can delegate `atom` to a validator. These [delegato
You can query the list of all validators of a specific chain:

```bash
gaiacli query validators
gaiacli query stake validators
```

If you want to get the information of a single validator you can check it with:

```bash
gaiacli query validator <account_cosmosval>
gaiacli query stake validator <account_cosmosval>
```

#### Bond Tokens

On the testnet, we delegate `steak` instead of `atom`. Here's how you can bond tokens to a testnet validator (*i.e.* delegate):

```bash
gaiacli tx delegate \
gaiacli tx stake delegate \
--amount=10steak \
--validator=$(gaiad tendermint show-validator) \
--name=<key_name> \
Expand All @@ -224,15 +224,15 @@ Don't use more `steak` thank you have! You can always get more by using the [Fau
Once submitted a delegation to a validator, you can see it's information by using the following command:

```bash
gaiacli query delegation \
gaiacli query stake delegation \
--address-delegator=<account_cosmos> \
--validator=<account_cosmosval>
```

Or if you want to check all your current delegations with disctinct validators:

```bash
gaiacli query delegations <account_cosmos>
gaiacli query stake delegations <account_cosmos>
```

You can also get previous delegation(s) status by adding the `--height` flag.
Expand All @@ -242,7 +242,7 @@ You can also get previous delegation(s) status by adding the `--height` flag.
If for any reason the validator misbehaves, or you just want to unbond a certain amount of tokens, use this following command. You can unbond a specific `shares-amount` (eg:`12.1`\) or a `shares-percent` (eg:`25`) with the corresponding flags.

```bash
gaiacli tx unbond begin \
gaiacli tx stake unbond \
--validator=<account_cosmosval> \
--shares-percent=100 \
--from=<key_name> \
Expand All @@ -263,21 +263,21 @@ gaiacli tx unbond complete \
Once you begin an unbonding-delegation, you can see it's information by using the following command:

```bash
gaiacli query unbonding-delegation \
gaiacli query stake unbonding-delegation \
--address-delegator=<account_cosmos> \
--validator=<account_cosmosval> \
```

Or if you want to check all your current unbonding-delegations with disctinct validators:

```bash
gaiacli query unbonding-delegations <account_cosmos>
gaiacli query stake unbonding-delegations <account_cosmos>
```

Additionally, as you can get all the unbonding-delegations from a particular validator:

```bash
gaiacli query unbonding-delegations-from <account_cosmosval>
gaiacli query stake unbonding-delegations-from <account_cosmosval>
```

To get previous unbonding-delegation(s) status on past blocks, try adding the `--height` flag.
Expand All @@ -287,7 +287,7 @@ To get previous unbonding-delegation(s) status on past blocks, try adding the `-
A redelegation is a type delegation that allows you to bond illiquid tokens from one validator to another:

```bash
gaiacli tx redelegate begin \
gaiacli tx stake redelegate \
--addr-validator-source=<account_cosmosval> \
--addr-validator-dest=<account_cosmosval> \
--shares-percent=50 \
Expand All @@ -311,7 +311,7 @@ gaiacli tx unbond complete \
Once you begin an redelegation, you can see it's information by using the following command:

```bash
gaiacli query redelegation \
gaiacli query stake redelegation \
--address-delegator=<account_cosmos> \
--addr-validator-source=<account_cosmosval> \
--addr-validator-dest=<account_cosmosval> \
Expand All @@ -320,13 +320,13 @@ gaiacli query redelegation \
Or if you want to check all your current unbonding-delegations with disctinct validators:

```bash
gaiacli query redelegations <account_cosmos>
gaiacli query stake redelegations <account_cosmos>
```

Additionally, as you can get all the outgoing redelegations from a particular validator:

```bash
gaiacli query redelegations-from <account_cosmosval>
gaiacli query stake redelegations-from <account_cosmosval>
```

To get previous redelegation(s) status on past blocks, try adding the `--height` flag.
Expand All @@ -335,8 +335,8 @@ To get previous redelegation(s) status on past blocks, try adding the `--height`

Parameters define high level settings for staking. You can get the current values by using:

```
gaiacli query parameters
```bash
gaiacli query stake parameters
```

With the above command you will get the values for:
Expand All @@ -354,8 +354,8 @@ All these values will be subject to updates though a `governance` process by `Pa

A staking `Pool` defines the dynamic parameters of the current state. You can query them with the following command:

```
gaiacli query pool
```bash
gaiacli query stake pool
```

With the `pool` command you will get the values for:
Expand Down Expand Up @@ -389,7 +389,7 @@ In order to create a governance proposal, you must submit an initial deposit alo
- `type`: Type of proposal. Must be of value _Text_ (types _SoftwareUpgrade_ and _ParameterChange_ not supported yet).

```bash
gaiacli tx submit-proposal \
gaiacli tx gov submit-proposal \
--title=<title> \
--description=<description> \
--type=<Text/ParameterChange/SoftwareUpgrade> \
Expand All @@ -404,13 +404,13 @@ gaiacli tx submit-proposal \
Once created, you can now query information of the proposal:

```bash
gaiacli query proposal --proposal-id=<proposal_id>
gaiacli query gov proposal --proposal-id=<proposal_id>
```

Or query all available proposals:

```bash
gaiacli query proposals
gaiacli query gov proposals
```

You can also query proposals filtered by `voter` or `depositer` by using the corresponding flags.
Expand All @@ -420,7 +420,7 @@ You can also query proposals filtered by `voter` or `depositer` by using the cor
In order for a proposal to be broadcasted to the network, the amount deposited must be above a `minDeposit` value (default: `10 steak`). If the proposal you previously created didn't meet this requirement, you can still increase the total amount deposited to activate it. Once the minimum deposit is reached, the proposal enters voting period:

```bash
gaiacli tx deposit \
gaiacli tx gov deposit \
--proposal-id=<proposal_id> \
--depositer=<account_cosmos> \
--deposit=<200steak> \
Expand All @@ -435,13 +435,13 @@ gaiacli tx deposit \
Once a new proposal is created, you can query all the deposits submitted to it:

```bash
gaiacli query deposits --proposal-id=<proposal_id>
gaiacli query gov deposits --proposal-id=<proposal_id>
```

You can also query a deposit submitted by a specific address:

```bash
gaiacli query deposit \
gaiacli query gov deposit \
--proposal-id=<proposal_id> \
--depositer=<account_cosmos>
```
Expand All @@ -451,7 +451,7 @@ gaiacli query deposit \
After a proposal's deposit reaches the `MinDeposit` value, the voting period opens. Bonded `Atom` holders can then cast vote on it:

```bash
gaiacli tx vote \
gaiacli tx gov vote \
--proposal-id=<proposal_id> \
--voter=<account_cosmos> \
--option=<Yes/No/NoWithVeto/Abstain> \
Expand All @@ -464,21 +464,21 @@ gaiacli tx vote \
Check the vote with the option you just submitted:

```bash
gaiacli query vote \
gaiacli query gov vote \
--proposal-id=<proposal_id> \
--voter=<account_cosmos>
```

You can also get all the previous votes submitted to the proposal with:

```bash
gaiacli query votes --proposal-id=<proposal_id>
gaiacli query gov votes --proposal-id=<proposal_id>
```

#### Query proposal tally results

To check the current tally of a given proposal you can use the `tally` command:

```bash
gaiacli query tally --proposal-id=<proposal_id>
gaiacli query gov tally --proposal-id=<proposal_id>
```
18 changes: 9 additions & 9 deletions docs/gaia/validators/validator-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Validator Setup

:::
:::
The current testnet is `gaia-9001`.
:::

Expand All @@ -22,14 +22,14 @@ Your `cosmosvalconspub` can be used to create a new validator by staking tokens.
gaiad tendermint show-validator
```

Next, craft your `gaiacli tx create-validator` command:
Next, craft your `gaiacli tx stake create-validator` command:

::: warning Note
Don't use more `steak` thank you have! You can always get more by using the [Faucet](https://faucetcosmos.network/)!
:::

```bash
gaiacli tx create-validator \
gaiacli tx stake create-validator \
--amount=5steak \
--pubkey=$(gaiad tendermint show-validator) \
--moniker="choose a moniker" \
Expand All @@ -45,7 +45,7 @@ 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.

::: tip
Use `gaiacli tx create-validator -h` to get a list of all the available flags.
Use `gaiacli tx stake create-validator -h` to get a list of all the available flags.
:::

### Edit Validator Description
Expand All @@ -55,7 +55,7 @@ You can edit your validator's public description. This info is to identify your
The `--identity` can be used as to verify identity with systems like Keybase or UPort. When using with Keybase `--identity` should be populated with a 16-digit string that is generated with a [keybase.io](https://keybase.io) account. It's a cryptographically secure method of verifying your identity across multiple online networks. The Keybase API allows us to retrieve your Keybase avatar. This is how you can add a logo to your validator profile.

```bash
gaiacli tx edit-validator
gaiacli tx stake edit-validator
--moniker="choose a moniker" \
--website="https://cosmos.network" \
--identity=6A0D65E29A4CBC8E \
Expand All @@ -77,15 +77,15 @@ __Note__: The `commission-rate` value must adhere to the following invariants:
View the validator's information with this command:

```bash
gaiacli query validator <account_cosmos>
gaiacli query stake validator <account_cosmos>
```

### 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:

```bash
gaiacli query signing-info <validator-pubkey>\
gaiacli query slashing signing-info <validator-pubkey>\
--chain-id=<chain_id>
```

Expand All @@ -94,7 +94,7 @@ gaiacli query signing-info <validator-pubkey>\
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).

```bash
gaiacli tx unjail \
gaiacli tx slashing unjail \
--from=<key_name> \
--chain-id=<chain_id>
```
Expand Down Expand Up @@ -128,7 +128,7 @@ gaiad start
Wait for your full node to catch up to the latest block. Next, run the following command. Note that `<cosmos>` is the address of your validator account, and `<name>` is the name of the validator account. You can find this info by running `gaiacli keys list`.

```bash
gaiacli tx unjail <cosmos> --chain-id=<chain_id> --from=<from>
gaiacli tx slashing unjail <cosmos> --chain-id=<chain_id> --from=<from>
```

::: danger Warning
Expand Down

0 comments on commit 5a671e7

Please sign in to comment.