Skip to content

Commit 5ef1315

Browse files
authored
chore: fix typos (#2389)
* fix typos * fix typos
1 parent 6db885c commit 5ef1315

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

Diff for: docs/docs/build/modules/02-provider.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 5
1010

1111
The ICS provider module enables a proof-of-stake chain (known as the provider chain)
1212
to share (parts of) its security with other chains (known as consumer chains).
13-
This basically mean that consumer chains can run as proof-of-stake chains using
13+
This basically means that consumer chains can run as proof-of-stake chains using
1414
(parts of) the stake locked on the provider as collateral.
1515

1616
The provider module has the following functionalities:
@@ -19,11 +19,11 @@ The provider module has the following functionalities:
1919
- The customization of the consumer chains validator sets.
2020
- The option for validators to opt in to validate the consumer chains they want.
2121
- The distribution of rewards from consumer chains to the opted in validators.
22-
- The slashing and jailing of validators commiting infractions on consumer chains based on cryptographic evidence.
22+
- The slashing and jailing of validators committing infractions on consumer chains based on cryptographic evidence.
2323

2424
## State
2525

26-
For clarity, the description of the the provider module state is split into features.
26+
For clarity, the description of the provider module state is split into features.
2727
For a more accurate description, check out the `x/ccv/provider/types/keys.go` file, which contains the definitions of all the keys.
2828

2929
### Consumer Lifecycle
@@ -144,7 +144,7 @@ Format: `byte(53) | len(clientId) | []byte(clientId) -> string`
144144
Format: `byte(14) | []byte(consumerId) -> ConsumerGenesisState`
145145

146146

147-
### Key Assingment
147+
### Key Assignment
148148

149149
#### ConsumerValidators
150150

@@ -162,7 +162,7 @@ Format: `byte(23) | len(consumerId) | []byte(consumerId) | addr -> sdk.ConsAddre
162162

163163
#### ConsumerAddrsToPruneV2
164164

165-
`ConsumerAddrsToPruneV2` stores the list of consumer consensus addresses that can be prunned at a timestamp `ts` as they are no longer needed.
165+
`ConsumerAddrsToPruneV2` stores the list of consumer consensus addresses that can be pruned at a timestamp `ts` as they are no longer needed.
166166

167167
Format: `byte(40) | len(consumerId) | []byte(consumerId) | ts -> AddressList`, where `AddressList` is defined as
168168

@@ -215,7 +215,7 @@ Format: `byte(36) | len(consumerId) | []byte(consumerId) | addr -> []byte{}`, wi
215215
#### Denylist
216216

217217
`Denylist` is the list of provider validators that are not eligible to validate a given consumer chain.
218-
Note that validator can opt in regardless of whether they are eligible or not.
218+
Note that validators can opt in regardless of whether they are eligible or not.
219219

220220
Format: `byte(37) | len(consumerId) | []byte(consumerId) | addr -> []byte{}`, with `addr` the validator's consensus address on the provider chain.
221221

@@ -277,7 +277,7 @@ message ConsensusValidator {
277277
#### ConsumerRewardDenoms
278278

279279
`ConsumerRewardDenoms` is storing the list of whitelisted denoms that are accepted as ICS rewards.
280-
Note that denoms that are not whitelisted can still be transfer to the `consumer_rewards_pool` account on the provider module, but they will not be distributed to validators and their delegators.
280+
Note that denoms that are not whitelisted can still be transferred to the `consumer_rewards_pool` account on the provider module, but they will not be distributed to validators and their delegators.
281281

282282
Format: `byte(27) | []byte(denom) -> []byte{}`
283283

@@ -375,7 +375,7 @@ The consumer module is an IBC application that implements the [IBC module callba
375375

376376
`OnChanOpenTry` validates the parameters of the _CCV channel_ -- an ordered IBC channel connected on the `provider` port
377377
and with the counterparty port set to `consumer` -- and asserts that the counterparty version matches the expected version
378-
(only verions `1` is supported).
378+
(only version `1` is supported).
379379

380380
If the validation passes, the provider module verifies that the underlying client is the expected client of the consumer chain
381381
(i.e., the client created during the consumer chain launch) and that no other CCV channel exists for this consumer chain.
@@ -489,11 +489,11 @@ The owner of the created consumer chain is the submitter of the message.
489489
This message cannot be submitted as part of a governance proposal, i.e., the submitter cannot be the gov module account address.
490490
As a result, if the `power_shaping_parameters` are provided, then `power_shaping_parameters.top_N` must be set to zero (i.e., opt-in consumer chain).
491491

492-
To create a top-n consumer chain, the following steps are require:
492+
To create a top-n consumer chain, the following steps are required:
493493

494-
- Create a opt-in consumer chain (via `MsgCreateConsumer`).
495-
- Change the ownership of the consuemr chain to the gov module account address (via `MsgUpdateConsumer`).
496-
- Change `power_shaping_parameters.top_N` to a value in `[50, 100]` trough a governance proposal with a `MsgUpdateConsumer` message.
494+
- Create an opt-in consumer chain (via `MsgCreateConsumer`).
495+
- Change the ownership of the consumer chain to the gov module account address (via `MsgUpdateConsumer`).
496+
- Change `power_shaping_parameters.top_N` to a value in `[50, 100]` through a governance proposal with a `MsgUpdateConsumer` message.
497497

498498
If the `initialization_parameters` field is set and `initialization_parameters.spawn_time > 0`, then the consumer chain will be scheduled to launch at `spawn_time`.
499499

@@ -524,7 +524,7 @@ message MsgCreateConsumer {
524524
`MsgUpdateConsumer` enables the owner of a consumer chain to update its parameters (e.g., set a new owner).
525525

526526
Note that only the `owner` (i.e., signer) and `consumer_id` fields are mandatory.
527-
The others field are optional. Not providing one of them will leave the existing values unchanged.
527+
The others fields are optional. Not providing one of them will leave the existing values unchanged.
528528
Providing one of `metadata`, `initialization_parameters`, `power_shaping_parameters`, or `allowlisted_reward_denoms`
529529
will update all the containing fields.
530530
If one of the containing fields is missing, it will be set to its zero value.
@@ -606,7 +606,7 @@ You can use the `list-consumer-chains` query to get the list of all consumer cha
606606

607607
The `consumer_key` field is optional.
608608
It enables the validator to set the consensus public key to use on the consumer chain.
609-
The validator can assing (or re-assing) this key also later via [MsgAssignConsumerKey](#msgassignconsumerkey).
609+
The validator can assign (or re-assign) this key also later via [MsgAssignConsumerKey](#msgassignconsumerkey).
610610

611611
:::warning
612612
Validators are strongly recommended to assign a separate key for each consumer chain
@@ -758,7 +758,7 @@ message MsgSetConsumerCommissionRate {
758758

759759
### MsgSubmitConsumerMisbehaviour
760760

761-
`MsgSubmitConsumerMisbehaviour` enables users to submit to the provider evidence of a light client attack that occured on a consumer chain.
761+
`MsgSubmitConsumerMisbehaviour` enables users to submit to the provider evidence of a light client attack that occurred on a consumer chain.
762762
This message can be submitted directly by users, e.g., via the CLI command `tx provider submit-consumer-misbehaviour`,
763763
or by a relayer that can be set to automatically detect consumer chain misbehaviors, e.g., [Hermes](https://github.com/informalsystems/hermes).
764764

@@ -768,7 +768,7 @@ the `chain_id` field is deprecated.
768768
Users should use `consumer_id` instead.
769769
You can use the `list-consumer-chains` query to get the list of all consumer chains and their consumer IDs.
770770

771-
For more details on reporting light client attacks that occured on consumer chains, check out the [guide on equivocation infractions](../../features/slashing.md#equivocation-infractions).
771+
For more details on reporting light client attacks that occurred on consumer chains, check out the [guide on equivocation infractions](../../features/slashing.md#equivocation-infractions).
772772

773773
```proto
774774
message MsgSubmitConsumerMisbehaviour {
@@ -787,7 +787,7 @@ message MsgSubmitConsumerMisbehaviour {
787787

788788
### MsgSubmitConsumerDoubleVoting
789789

790-
`MsgSubmitConsumerDoubleVoting` enables users to submit to the provider evidence of a double signing infraction that occured on a consumer chain.
790+
`MsgSubmitConsumerDoubleVoting` enables users to submit to the provider evidence of a double signing infraction that occurred on a consumer chain.
791791
This message can be submitted directly by users, e.g., via the CLI command `tx provider submit-consumer-double-voting`,
792792
or by a relayer that can be set to automatically detect consumer chain misbehaviors, e.g., [Hermes](https://github.com/informalsystems/hermes).
793793

@@ -797,7 +797,7 @@ the `chain_id` field is deprecated.
797797
Users should use `consumer_id` instead.
798798
You can use the `list-consumer-chains` query to get the list of all consumer chains and their consumer IDs.
799799

800-
For more details on reporting double signing infractions that occured on consumer chains, check out the [guide on equivocation infractions](../../features/slashing.md#equivocation-infractions).
800+
For more details on reporting double signing infractions that occurred on consumer chains, check out the [guide on equivocation infractions](../../features/slashing.md#equivocation-infractions).
801801

802802
```proto
803803
message MsgSubmitConsumerDoubleVoting {
@@ -841,7 +841,7 @@ In the `EndBlock` of the provider module the following actions are performed:
841841
- Prune the no-longer needed public keys assigned by validators to use when validating on consumer chains.
842842
- Send validator updates to the consensus engine.
843843
The maximum number of validators is set through the [MaxProviderConsensusValidators](#maxproviderconsensusvalidators) param.
844-
- At the begining of every epoch,
844+
- At the beginning of every epoch,
845845
- for every launched consumer chain, compute the next consumer validator set and send it to the consumer chain via an IBC packet;
846846
- increment the VSC id.
847847

@@ -872,7 +872,7 @@ The provider module contains the following parameters.
872872

873873
`TrustingPeriodFraction` is used to used to compute the trusting period of IBC clients
874874
(for both provider and consumer chains) as `UnbondingPeriod / TrustingPeriodFraction`.
875-
Note that a light clients must be updated within the trusting period in order to avoid being frozen.
875+
Note that a light client must be updated within the trusting period in order to avoid being frozen.
876876

877877
The param is set as a string, and converted to a `sdk.Dec` when used.
878878

@@ -938,7 +938,7 @@ which might impact the security of the consumer chains.
938938
| int64 | 24 |
939939

940940
`NumberOfEpochsToStartReceivingRewards` is the number of ICS epochs that a validator
941-
needs to wait after opting in on a consumer chain before being eligible to ICS reawards
941+
needs to wait after opting in on a consumer chain before being eligible to ICS rewards
942942
from that consumer.
943943

944944
### MaxProviderConsensusValidators
@@ -948,7 +948,7 @@ from that consumer.
948948
| int64 | 180 |
949949

950950
`MaxProviderConsensusValidators` is the maximum number of validators sent to
951-
the provider consensus enginer.
951+
the provider consensus engine.
952952
This was introduced with the [Inactive Provider Validators feature](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators)
953953
and it replaces the `MaxValidators` staking module parameter.
954954
As a result, the provider chain can differentiate between

Diff for: docs/docs/build/modules/03-consumer.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The ICS consumer module enables consumer chains to use stake locked on a provide
1212
as collateral for their own proof-of-stake based block production.
1313

1414
The consumer module established a IBC ordered channel to the provider chain.
15-
This channel is used by the provider chain to regularly sent validator updates the the consumer chain.
15+
This channel is used by the provider chain to regularly send validator updates to the consumer chain.
1616
The consumer sends these updates to its own consensus engine.
1717
This means that the consumer module acts as a staking module of the consumer chain.
1818

@@ -25,7 +25,7 @@ As a result, the misbehaving validator is punished on the provider chain.
2525

2626
## State
2727

28-
For clarity, the description of the the consumer module state is split into features.
28+
For clarity, the description of the consumer module state is split into features.
2929
For a more accurate description, check out the `x/ccv/consumer/types/keys.go` file, which contains the definitions of all the keys.
3030

3131
### Provider Connection
@@ -119,7 +119,7 @@ message CrossChainValidator {
119119
`HistoricalInfo` is the header and validator information for a given block.
120120
For more details, see the [Cosmos SDK docs](https://docs.cosmos.network/v0.50/build/modules/staking#historicalinfo).
121121

122-
Format: `byte(11) | height -> HistoricalInfo`, where `HistoricalInfo` is define in the staking module as
122+
Format: `byte(11) | height -> HistoricalInfo`, where `HistoricalInfo` is defined in the staking module as
123123

124124
```proto
125125
message HistoricalInfo {
@@ -213,7 +213,7 @@ The consumer module is an IBC application that implements the [IBC module callba
213213
`OnChanOpenInit` first verifies that the CCV channel was not already created.
214214
Then, it validates the channel parameters -- an ordered IBC channel connected on the `consumer` port
215215
and with the counterparty port set to `provider` -- and asserts that the version matches the expected version
216-
(only verions `1` is supported).
216+
(only version `1` is supported).
217217

218218
Finally, it verifies that the underlying client is the expected client of the provider chain
219219
(i.e., provided in the consumer module genesis state).
@@ -226,12 +226,12 @@ Finally, it verifies that the underlying client is the expected client of the pr
226226

227227
`OnChanOpenAck` first verifies that the CCV channel was not already created.
228228
Then it verifies that the counterparty version matches the expected version
229-
(only verions `1` is supported).
229+
(only version `1` is supported).
230230

231231
If the verification passes, it stores the [ProviderFeePoolAddr](#providerfeepooladdrstr) in the state.
232232

233233
Finally, if the [DistributionTransmissionChannel](#distributiontransmissionchannel) parameter is not set,
234-
it initiate the opening handshake for a token transfer channel over the same connection as the CCV channel
234+
it initiates the opening handshake for a token transfer channel over the same connection as the CCV channel
235235
by calling the `ChannelOpenInit` method of the IBC module.
236236

237237
### OnChanOpenConfirm
@@ -240,7 +240,7 @@ by calling the `ChannelOpenInit` method of the IBC module.
240240

241241
### OnChanCloseInit
242242

243-
`OnChanCloseInit` allow relayers to close duplicate OPEN channels, if the channel handshake is completed.
243+
`OnChanCloseInit` allows relayers to close duplicate OPEN channels, if the channel handshake is completed.
244244

245245
### OnChanCloseConfirm
246246

@@ -303,7 +303,7 @@ message MsgUpdateParams {
303303
In the `BeginBlock` of the consumer module the following actions are performed:
304304

305305
- Store in state the block height to VSC id mapping needed for sending to the provider the height of infractions committed on the consumer chain.
306-
- Track historical entries. This is the same lofic as in the `x/staking` module.
306+
- Track historical entries. This is the same logic as in the `x/staking` module.
307307

308308
## EndBlock
309309

@@ -313,7 +313,7 @@ In the `EndBlock` of the consumer module the following actions are performed:
313313
that was just upgraded to include the consumer module, then execute the [changeover logic](../../consumer-development/changeover-procedure.md).
314314
- Otherwise, distribute block rewards internally and once every [BlocksPerDistributionTransmission](#blocksperdistributiontransmission) send
315315
ICS rewards to the provider chain.
316-
- Send slash packets to the provider chain reporting infractions validators commited on the consumer chain.
316+
- Send slash packets to the provider chain reporting infractions validators committed on the consumer chain.
317317
- Send to the consensus engine validator updates reveived from the provider chain.
318318

319319
## Hooks
@@ -328,7 +328,7 @@ In the `EndBlock` of the consumer module the following actions are performed:
328328

329329
:::warning
330330
The consumer module parameters are set by the provider when creating the consumer genesis (i.e., when launching the consumer chain).
331-
As a result, changes of these parameters might results in incompatibilities between different versions of consumers and providers.
331+
As a result, changes of these parameters might result in incompatibilities between different versions of consumers and providers.
332332
:::
333333

334334
The consumer module contains the following parameters.

0 commit comments

Comments
 (0)