Skip to content

Commit

Permalink
docs: fix typos (#1144)
Browse files Browse the repository at this point in the history
* Fix: typo

* Fix: typo

* Fix: typo

* Fix: typos

* Fix: typo

* Fix: typos

* Fix: typos

---------

Co-authored-by: MSalopek <[email protected]>
Co-authored-by: Shawn <[email protected]>
  • Loading branch information
3 people authored Jul 17, 2023
1 parent d77fbf4 commit d837354
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/docs/adrs/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ If the proposed change will be large, please also indicate a way to do the chang

## References

> Are there any relevant PR comments, issues that led up to this, or articles referrenced for why we made the given design choice? If so link them here!
> Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
* {reference link}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For an example, see the [Democracy Consumer](https://github.com/cosmos/interchai

## CosmWasm

There several great DAO and governance frameworks written as CosmWasm contracts. These can be used as the main governance system for a consumer chain. Actions triggered by the CosmWasm governance contracts are able to affect parameters and trigger actions on the consumer chain.
There are several great DAO and governance frameworks written as CosmWasm contracts. These can be used as the main governance system for a consumer chain. Actions triggered by the CosmWasm governance contracts are able to affect parameters and trigger actions on the consumer chain.

For an example, see [Neutron](https://github.com/neutron-org/neutron/).

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/consumer-development/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To help validators and other node runners onboard onto your chain, please prepar

This should include (at minimum):

- [ ] genesis.json witout CCV data (before the propsal passes)
- [ ] genesis.json without CCV data (before the proposal passes)
- [ ] genesis.json with CCV data (after spawn time passes)
- [ ] information about relevant seed/peer nodes you are running
- [ ] relayer information (compatible versions)
Expand Down Expand Up @@ -73,7 +73,7 @@ Example of a consumer chain addition proposal.
// will be responsible for starting their consumer chain validator node.
"spawn_time": "2023-02-28T20:40:00.000000Z",
// Unbonding period for the consumer chain.
// It should should be smaller than that of the provider.
// It should be smaller than that of the provider.
"unbonding_period": 86400000000000,
// Timeout period for CCV related IBC packets.
// Packets are considered timed-out after this interval elapses.
Expand All @@ -96,7 +96,7 @@ Example of a consumer chain addition proposal.
// channel is created on top of the same connection as the CCV channel.
// Note that transfer_channel_id is the ID of the channel end on the consumer chain.
// it is most relevant for chains performing a sovereign to consumer changeover
// in order to maintan the existing ibc transfer channel
// in order to maintain the existing ibc transfer channel
"distribution_transmission_channel": "channel-123"
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/key-assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ gaiad tx provider assign-consensus-key <consumer-chain-id> '<pubkey>' --from <tx
- `consumer-chain-id` is the string identifier of the consumer chain, as assigned on the provider chain
- `consumer-pub-key` has the following format `{"@type":"/cosmos.crypto.ed25519.PubKey","key":"<key>"}`

Check that the key was assigned correcly by querying the provider:
Check that the key was assigned correctly by querying the provider:

```bash
gaiad query provider validator-consumer-key <consumer-chain-id> cosmosvalcons1e....3xsj3ayzf4uv6
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/features/proposals.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Minimal example:
"revision_number": 1,
},
// Unbonding period for the consumer chain.
// It should should be smaller than that of the provider.
// It should be smaller than that of the provider.
"unbonding_period": 86400000000000,
// Timeout period for CCV related IBC packets.
// Packets are considered timed-out after this interval elapses.
Expand All @@ -44,7 +44,7 @@ Minimal example:
"genesis_hash": "d86d756e10118e66e6805e9cc476949da2e750098fcc7634fd0cc77f57a0b2b0",
"binary_hash": "376cdbd3a222a3d5c730c9637454cd4dd925e2f9e2e0d0f3702fc922928583f1"
// relevant for chains performing a sovereign to consumer changeover
// in order to maintan the existing ibc transfer channel
// in order to maintain the existing ibc transfer channel
"distribution_transmission_channel": "channel-123"
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/features/slashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 4
---

# Consumer Initiated Slashing
A consumer chain is essentially a regular Cosmos-SDK based chain that uses the interchain security module to achieve economic security by stake deposited on the provider chain, instead of it's own chain.
A consumer chain is essentially a regular Cosmos-SDK based chain that uses the interchain security module to achieve economic security by stake deposited on the provider chain, instead of its own chain.
In essence, provider chain and consumer chains are different networks (different infrastructures) that are bound together by the provider's validator set. By being bound to the provider's validator set, a consumer chain inherits the economic security guarantees of the provider chain (in terms of total stake).

To maintain the proof of stake model, the consumer chain is able to send evidence of infractions (double signing and downtime) to the provider chain so the offending validators can be penalized.
Expand All @@ -17,7 +17,7 @@ reported by consumer chains are acted upon on the provider as soon as the provid
Instead of slashing, the provider will only jail offending validator for the duration of time established in the chain parameters.

:::info
Slash throttling (sometimes called jail throttling) mechanism insures that only a fraction of the validator set can be jailed at any one time to prevent malicious consumer chains from harming the provider.
Slash throttling (sometimes called jail throttling) mechanism ensures that only a fraction of the validator set can be jailed at any one time to prevent malicious consumer chains from harming the provider.
:::

## Double-signing (equivocation)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/introduction/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You may have heard of one or multiple buzzwords thrown around in the cosmos and

## Shared Security

Shared security is a family of technologies that include optimistic rollups, zk-rollups, sharding and Interchain Security. Ie. any protocol or technology that can allow one blockchain to lend/share it's proof-of-stake security with another blockchain or off-chain process.
Shared security is a family of technologies that include optimistic rollups, zk-rollups, sharding and Interchain Security. Ie. any protocol or technology that can allow one blockchain to lend/share its proof-of-stake security with another blockchain or off-chain process.

## Interchain Security

Expand Down

0 comments on commit d837354

Please sign in to comment.