Skip to content

Commit

Permalink
fix broken links from sdk docs update (#1798)
Browse files Browse the repository at this point in the history
* fix

* forgot one
  • Loading branch information
okwme authored Oct 10, 2022
1 parent 6d0c078 commit 3466bc9
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/governance/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ You use can also use [Hubble](https://hubble.figment.io/cosmos/chains/cosmoshub-
## Params Change


**Note:** Changes to the [`gov` module](https://docs.cosmos.network/main/modules/gov/) are different from the other kinds of parameter changes because `gov` has subkeys, [as discussed here](https://github.com/cosmos/cosmos-sdk/issues/5800). Only the `key` part of the JSON file is different for `gov` parameter-change proposals.
**Note:** Changes to the [`gov` module](https://docs.cosmos.network/main/modules/gov) are different from the other kinds of parameter changes because `gov` has subkeys, [as discussed here](https://github.com/cosmos/cosmos-sdk/issues/5800). Only the `key` part of the JSON file is different for `gov` parameter-change proposals.

For parameter-change proposals, there are seven (7) components:

Expand Down Expand Up @@ -133,7 +133,7 @@ The deposit `denom` is `uatom` and `amount` is `100000`. Since 1,000,000 micro-A
### Mainnet Example


To date, the Cosmos Hub's parameters have not been changed by a parameter-change governance proposal. This is a hypothetical example of the JSON file that would be used with a command line transaction to create a new proposal. This is an example of a proposal that changes two parameters, and both parameters are from the [`slashing` module](https://docs.cosmos.network/main/modules/slashing/). A single parameter-change governance proposal can reportedly change any number of parameters.
To date, the Cosmos Hub's parameters have not been changed by a parameter-change governance proposal. This is a hypothetical example of the JSON file that would be used with a command line transaction to create a new proposal. This is an example of a proposal that changes two parameters, and both parameters are from the [`slashing` module](https://docs.cosmos.network/main/modules/slashing). A single parameter-change governance proposal can reportedly change any number of parameters.


```json
Expand Down
2 changes: 1 addition & 1 deletion docs/governance/params-change/Crisis.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `crisis` module is responsible for halting the blockchain under the circumst
### `ConstantFee`
**The amount required to send a message to halt the Cosmos Hub chain if an invariant is broken, in micro-ATOM.**

A Cosmos account (address) can send a transaction message that will halt the Cosmos Hub chain if an invariant is broken. An example of this would be if all of the account balances in total did not equal the total supply. This kind of transaction could consume excessive amounts of gas to compute, beyond the maximum allowable block gas limit. `ConstantFee` makes it possible to bypass the gas limit in order to process this transaction, while setting a cost to disincentivize using the function to attack the network. The cost of the transaction is `1333000000` `uatom` (1,333 ATOM) and will effectively not be paid if the chain halts due to a broken invariant (which similar to being refunded). If the invariant is not broken, then `ConstantFee` will be paid. All in Bits has published more information about the [crisis module here](https://docs.cosmos.network/main/modules/crisis/).
A Cosmos account (address) can send a transaction message that will halt the Cosmos Hub chain if an invariant is broken. An example of this would be if all of the account balances in total did not equal the total supply. This kind of transaction could consume excessive amounts of gas to compute, beyond the maximum allowable block gas limit. `ConstantFee` makes it possible to bypass the gas limit in order to process this transaction, while setting a cost to disincentivize using the function to attack the network. The cost of the transaction is `1333000000` `uatom` (1,333 ATOM) and will effectively not be paid if the chain halts due to a broken invariant (which similar to being refunded). If the invariant is not broken, then `ConstantFee` will be paid. All in Bits has published more information about the [crisis module here](https://docs.cosmos.network/main/modules/crisis).

* on-chain value: `{{ $themeConfig.currentParameters.crisis.ConstantFee }}`
* `cosmoshub-4` default: `1333000000` `uatom`
Expand Down
12 changes: 6 additions & 6 deletions docs/governance/params-change/Slashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If a validator in the active set is offline for too long, the validator will be

How long is being offline for too long? There are two components: `SignedBlocksWindow` and [`MinSignedPerWindow`](#MinSignedPerWindow). Since `MinSignedPerWindow` is 5% and `SignedBlocksWindow` is 10,000, a validator must have signed at least 5% of 10,000 blocks (500 out of 10,000) at any given time to comply with protocol rules. That means a validator that misses 9,500 consecutive blocks will be considered by the system to have committed a liveness violation. The time window for being offline without breaking system rules is proportional to this parameter.

More about liveness [here](https://docs.cosmos.network/main/modules/slashing/#signing-info-liveness).
More about liveness [here](https://docs.cosmos.network/main/modules/slashing#signing-info-liveness).

#### Decreasing the value of `SignedBlocksWindow`
Decreasing the value of the `SignedBlocksWindow` parameter will decrease the window for complying with the system's liveness rules. This will make it more likely that offline validators will be slashed by [`SlashFractionDowntime`](#SlashFractionDowntime) and temporarily removed from the active set for at least [`DowntimeJailDuration`](#DowntimeJailDuration). While out of the active set, the votes of the validator and its delegators do not count toward governance proposals.
Expand Down Expand Up @@ -62,7 +62,7 @@ If a validator in the active set is offline for too long, the validator will be
How long is being offline for too long? There are two components: [`SignedBlocksWindow`](#SignedBlocksWindow) and `MinSignedPerWindow`. Since `MinSignedPerWindow` is 5% and `SignedBlocksWindow` is 10,000, a validator must have signed at least 5% of 10,000 blocks (500 out of 10,000) at any given time to comply with protocol rules. That means a validator that misses 9,500 consecutive blocks will be considered by the system to have committed a liveness violation. The threshold-proportion of blocks is determined by this parameter, so the greater that `MinSignedPerWindow` is, the lower the tolerance for missed blocks by the system.


More about liveness [here](https://docs.cosmos.network/main/modules/slashing/#signing-info-liveness).
More about liveness [here](https://docs.cosmos.network/main/modules/slashing#signing-info-liveness).

#### Decreasing the value of `MinSignedPerWindow`
Decreasing the value of the `MinSignedPerWindow` parameter will increase the threshold for complying with the system's liveness rules. This will make it less likely that offline validators will be slashed by [`SlashFractionDowntime`](#5-SlashFractionDowntime) and temporarily removed from the active set for at least [`DowntimeJailDuration`](#3-DowntimeJailDuration). While out of the active set, the votes of the validator and its delegators do not count toward governance proposals.
Expand Down Expand Up @@ -94,9 +94,9 @@ That's ~17.5 hours instead of ~18.5 hours, assuming 7s block times.
* `cosmoshub-3` default: `600000000000`


A validator in the active set that's offline for too long, besides being slashed, will be temporarily removed from the active set (aka "[jailed](https://docs.cosmos.network/main/modules/slashing/#unjail)") for at least [`DowntimeJailDuration`](#DowntimeJailDuration), which is 10 minutes (`600000000000` nanoseconds). During this time, a validator is not able to sign blocks and its delegators will not earn staking rewards. After the `DowntimeJailDuration` period has passed, the validator operator may send an "[unjail](https://docs.cosmos.network/main/modules/slashing/#unjail)" transaction to resume validator operations.
A validator in the active set that's offline for too long, besides being slashed, will be temporarily removed from the active set (aka "[jailed](https://docs.cosmos.network/main/modules/slashing#unjail)") for at least [`DowntimeJailDuration`](#DowntimeJailDuration), which is 10 minutes (`600000000000` nanoseconds). During this time, a validator is not able to sign blocks and its delegators will not earn staking rewards. After the `DowntimeJailDuration` period has passed, the validator operator may send an "[unjail](https://docs.cosmos.network/main/modules/slashing#unjail)" transaction to resume validator operations.

More about liveness [here](https://docs.cosmos.network/main/modules/slashing/#signing-info-liveness).
More about liveness [here](https://docs.cosmos.network/main/modules/slashing#signing-info-liveness).


#### Decreasing the value of `DowntimeJailDuration`
Expand All @@ -113,7 +113,7 @@ Increasing the value of the `DowntimeJailDuration` parameter will require a vali
* `cosmoshub-3` default: `0.050000000000000000`


A validator proven to have signed two blocks at the same height is considered to have committed equivocation, and the system will then permanently burn ("slash") that validator's total delegations (aka stake-backing) by `0.050000000000000000` (5%). All delegators to an offending validator will lose 5% of all ATOMs delegated to this validator. At this point the validator will be "[tombstoned](https://docs.cosmos.network/main/modules/slashing/#staking-tombstone)," which means the validator will be permanently removed from the active set of validators, and the validator's stake-backing will only be slashed one time (regardless of how many equivocations).
A validator proven to have signed two blocks at the same height is considered to have committed equivocation, and the system will then permanently burn ("slash") that validator's total delegations (aka stake-backing) by `0.050000000000000000` (5%). All delegators to an offending validator will lose 5% of all ATOMs delegated to this validator. At this point the validator will be "[tombstoned](https://docs.cosmos.network/main/modules/slashing#staking-tombstone)," which means the validator will be permanently removed from the active set of validators, and the validator's stake-backing will only be slashed one time (regardless of how many equivocations).

#### Decreasing the value of `SlashFractionDoubleSign`
Decreasing the value of the `SlashFractionDoubleSign` parameter will lessen the penalty for equivocation, and offending validators will have a smaller proportion of their stake-backing burned. This may reduce the motivation for operators to ensure that their validators are secure.
Expand All @@ -128,7 +128,7 @@ Increasing the value of the `SlashFractionDoubleSign` parameter will heighten th
* `cosmoshub-4` default: `0.000100000000000000`
* `cosmoshub-3` default: `0.000100000000000000`

If a validator in the active set is offline for too long, the system will permanently burn ("slash") that validator's total delegations (aka stake-backing) by a `SlashFractionDowntime` of `0.000100000000000000` (0.01%). All delegators to an offending validator will lose 0.01% of all ATOMs delegated to this validator. At this point the validator will be "[jailed](https://docs.cosmos.network/main/modules/slashing/#unjail)," which means the validator will be temporarily removed from the active set of validators so the validator's stake-backing will only be slashed one time.
If a validator in the active set is offline for too long, the system will permanently burn ("slash") that validator's total delegations (aka stake-backing) by a `SlashFractionDowntime` of `0.000100000000000000` (0.01%). All delegators to an offending validator will lose 0.01% of all ATOMs delegated to this validator. At this point the validator will be "[jailed](https://docs.cosmos.network/main/modules/slashing#unjail)," which means the validator will be temporarily removed from the active set of validators so the validator's stake-backing will only be slashed one time.

#### Decreasing the value of `SlashFractionDowntime`
Decreasing the value of the `SlashFractionDowntime` parameter will lessen the penalty for liveness violations, and offending validators will have a smaller proportion of their stake-backing burned. This may reduce the motivation for operators to ensure that their validators are online.
Expand Down
2 changes: 1 addition & 1 deletion docs/governance/params-change/param-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Given a subspace and an associated key, you can query on chain parameters using
gaiad query params subspace <subspace_name> <key> --node <node_address> --chain-id <chain_id>
```

For more information on specific modules, refer to the [Cosmos SDK documentation on modules](https://docs.cosmos.network/main/).
For more information on specific modules, refer to the [Cosmos SDK documentation on modules](https://docs.cosmos.network/main).

## Current subspaces, keys, and values

Expand Down
2 changes: 1 addition & 1 deletion docs/governance/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the past, different people have considered contributions amounts differently.

#### Burned deposits

Deposits are burned only when proposals are vetoed i.e. 33.4% of voting power backing the 'NoWithVeto' option as documented in the [Cosmos SDK gov module spec](https://docs.cosmos.network/main/modules/gov/#deposit-refund-and-burn).
Deposits are burned only when proposals are vetoed i.e. 33.4% of voting power backing the 'NoWithVeto' option as documented in the [Cosmos SDK gov module spec](https://docs.cosmos.network/main/modules/gov#deposit-refund-and-burn).

### 2. Voting Period

Expand Down
4 changes: 2 additions & 2 deletions docs/governance/state-of-cosmos-governance-2021.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The Cosmos ecosystem emphasizes governance mechanisms in order to achieve the vision of an ecosystem of interoperable blockchains supported by interchain infrastructure and services on the Cosmos Hub and beyond. The intent is that Cosmos Hub is operated by the community of code development teams supported by the Interchain Foundation, validators and ATOM token holders as a form of distributed organization.

Cosmos Hub has a [Governance (x/gov) module](https://docs.cosmos.network/main/modules/gov/) for coordinating various changes to the blockchain through parameters, upgrades and proposals (the [white paper](https://v1.cosmos.network/resources/whitepaper) refers to text amendments to the "human-readable constitution" setting out Cosmos Hub policies). However, the ecosystem also has additional on- and off- chain processes that exist to set technical direction and inculcate social norms.
Cosmos Hub has a [Governance (x/gov) module](https://docs.cosmos.network/main/modules/gov) for coordinating various changes to the blockchain through parameters, upgrades and proposals (the [white paper](https://v1.cosmos.network/resources/whitepaper) refers to text amendments to the "human-readable constitution" setting out Cosmos Hub policies). However, the ecosystem also has additional on- and off- chain processes that exist to set technical direction and inculcate social norms.

Reviewing existing governance documentation and discussion, a few key themes surfaced:

Expand All @@ -21,7 +21,7 @@ Each blockchain in the Cosmos ecosystem can be tailored to a specific applicatio

### Development of Governance Processes Over Time

The existing [governance module](https://docs.cosmos.network/main/modules/gov/) is described as a minimum viable product for the governance module, with [ideas for future improvement](https://docs.cosmos.network/main/modules/gov/05_future_improvements.html) . For example an active product team is currently aligning [groups and governance functionality](https://docs.google.com/document/d/1w-fwa8i8kkgirbn9DOFklHwcu9xO_IdbMN910ASr2oQ/edit#) will change current governance practices and open up new avenues to explore and support through on- and off- chain processes
The existing [governance module](https://docs.cosmos.network/main/modules/gov) is described as a minimum viable product for the governance module, with [ideas for future improvement](https://docs.cosmos.network/main/modules/gov#future-improvements) . For example an active product team is currently aligning [groups and governance functionality](https://docs.google.com/document/d/1w-fwa8i8kkgirbn9DOFklHwcu9xO_IdbMN910ASr2oQ/edit#) will change current governance practices and open up new avenues to explore and support through on- and off- chain processes


## On- and off-chain Governance Structure
Expand Down
2 changes: 1 addition & 1 deletion docs/proto/proto-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Params defines the set of module parameters.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `minimum_gas_prices` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | repeated | Minimum stores the minimum gas price(s) for all TX on the chain. When multiple coins are defined then they are accepted alternatively. The list must be sorted by denoms asc. No duplicate denoms or zero amount values allowed. For more information see https://docs.cosmos.network/main/modules/auth/#concepts |
| `minimum_gas_prices` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | repeated | Minimum stores the minimum gas price(s) for all TX on the chain. When multiple coins are defined then they are accepted alternatively. The list must be sorted by denoms asc. No duplicate denoms or zero amount values allowed. For more information see https://docs.cosmos.network/main/modules/auth#concepts |



Expand Down
2 changes: 1 addition & 1 deletion proto/gaia/globalfee/v1beta1/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ message Params {
// When multiple coins are defined then they are accepted alternatively.
// The list must be sorted by denoms asc. No duplicate denoms or zero amount
// values allowed. For more information see
// https://docs.cosmos.network/main/modules/auth/#concepts
// https://docs.cosmos.network/main/modules/auth#concepts
repeated cosmos.base.v1beta1.DecCoin minimum_gas_prices = 1 [
(gogoproto.nullable) = false,
(gogoproto.jsontag) = "minimum_gas_prices,omitempty",
Expand Down
2 changes: 1 addition & 1 deletion x/globalfee/types/genesis.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3466bc9

Please sign in to comment.