From ed1002ca08f4bdc7f9ce65e7f9b269d534882d62 Mon Sep 17 00:00:00 2001 From: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Date: Wed, 2 Oct 2024 12:04:38 +0000 Subject: [PATCH] chore: spelling errors fixes --- contrib/local-testnet.sh | 4 ++-- docs/docs/build/modules/02-provider.md | 24 +++++++++---------- docs/docs/build/modules/03-consumer.md | 6 ++--- .../hypha-consumer-start-process.excalidraw | 18 +++++++------- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/contrib/local-testnet.sh b/contrib/local-testnet.sh index 3aebbbe262..bb66a52532 100755 --- a/contrib/local-testnet.sh +++ b/contrib/local-testnet.sh @@ -69,7 +69,7 @@ do sleep 1 - # Create account keypair + # Create account key pair interchain-security-pd keys add $PROV_KEY --home ${PROV_NODE_DIR} --keyring-backend test --output json > ${PROV_NODE_DIR}/${PROV_KEY}.json 2>&1 sleep 1 @@ -393,7 +393,7 @@ do sleep 1 - # Create account keypair + # Create account key pair interchain-security-cd keys add $PROV_KEY --home ${CONS_NODE_DIR} --keyring-backend test --output json > ${CONS_NODE_DIR}/${PROV_KEY}.json 2>&1 sleep 1 diff --git a/docs/docs/build/modules/02-provider.md b/docs/docs/build/modules/02-provider.md index 2ddcf52419..2ae0db5be4 100644 --- a/docs/docs/build/modules/02-provider.md +++ b/docs/docs/build/modules/02-provider.md @@ -19,7 +19,7 @@ The provider module has the following functionalities: - The customization of the consumer chains validator sets. - The option for validators to opt in to validate the consumer chains they want. - The distribution of rewards from consumer chains to the opted in validators. -- The slashing and jailing of validators commiting infractions on consumer chains based on cryptographic evidence. +- The slashing and jailing of validators committing infractions on consumer chains based on cryptographic evidence. ## State @@ -144,7 +144,7 @@ Format: `byte(53) | len(clientId) | []byte(clientId) -> string` Format: `byte(14) | []byte(consumerId) -> ConsumerGenesisState` -### Key Assingment +### Key Assignment #### ConsumerValidators @@ -369,7 +369,7 @@ The consumer module is an IBC application that implements the [IBC module callba `OnChanOpenTry` validates the parameters of the _CCV channel_ -- an ordered IBC channel connected on the `provider` port and with the counterparty port set to `consumer` -- and asserts that the counterparty version matches the expected version -(only verions `1` is supported). +(only versions `1` is supported). If the validation passes, the provider module verifies that the underlying client is the expected client of the consumer chain (i.e., the client created during the consumer chain launch) and that no other CCV channel exists for this consumer chain. @@ -486,8 +486,8 @@ As a result, if the `power_shaping_parameters` are provided, then `power_shaping To create a top-n consumer chain, the following steps are require: - Create a opt-in consumer chain (via `MsgCreateConsumer`). -- Change the ownership of the consuemr chain to the gov module account address (via `MsgUpdateConsumer`). -- Change `power_shaping_parameters.top_N` to a value in `[50, 100]` trough a governance proposal with a `MsgUpdateConsumer` message. +- Change the ownership of the consumer chain to the gov module account address (via `MsgUpdateConsumer`). +- Change `power_shaping_parameters.top_N` to a value in `[50, 100]` through a governance proposal with a `MsgUpdateConsumer` message. 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`. @@ -525,7 +525,7 @@ If the `initialization_parameters` field is set and `initialization_parameters.s Updating the `spawn_time` from a positive value to zero will remove the consumer chain from the list of scheduled to launch chains. If the consumer chain is already launched, updating the `initialization_parameters` is no longer possible. -If the `power_shaping_parameters` field is set and `power_shaping_parameters.top_N` is possitive, then the owner needs to be the gov module account address. +If the `power_shaping_parameters` field is set and `power_shaping_parameters.top_N` is positive, then the owner needs to be the gov module account address. If the `new_owner_address` field is set to a value different than the gov module account address, then `top_N` needs to be zero. @@ -588,7 +588,7 @@ You can use the `list-consumer-chains` query to get the list of all consumer cha The `consumer_key` field is optional. It enables the validator to set the consensus public key to use on the consumer chain. -The validator can assing (or re-assing) this key also later via [MsgAssignConsumerKey](#msgassignconsumerkey). +The validator can assign (or re-assign) this key also later via [MsgAssignConsumerKey](#msgassignconsumerkey). :::warning Validators are strongly recommended to assign a separate key for each consumer chain @@ -740,7 +740,7 @@ message MsgSetConsumerCommissionRate { ### MsgSubmitConsumerMisbehaviour -`MsgSubmitConsumerMisbehaviour` enables users to submit to the provider evidence of a light client attack that occured on a consumer chain. +`MsgSubmitConsumerMisbehaviour` enables users to submit to the provider evidence of a light client attack that occurred on a consumer chain. This message can be submitted directly by users, e.g., via the CLI command `tx provider submit-consumer-misbehaviour`, or by a relayer that can be set to automatically detect consumer chain misbehaviors, e.g., [Hermes](https://github.com/informalsystems/hermes). @@ -750,7 +750,7 @@ the `chain_id` field is deprecated. Users should use `consumer_id` instead. You can use the `list-consumer-chains` query to get the list of all consumer chains and their consumer IDs. -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). +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). ```proto message MsgSubmitConsumerMisbehaviour { @@ -769,7 +769,7 @@ message MsgSubmitConsumerMisbehaviour { ### MsgSubmitConsumerDoubleVoting -`MsgSubmitConsumerDoubleVoting` enables users to submit to the provider evidence of a double signing infraction that occured on a consumer chain. +`MsgSubmitConsumerDoubleVoting` enables users to submit to the provider evidence of a double signing infraction that occurred on a consumer chain. This message can be submitted directly by users, e.g., via the CLI command `tx provider submit-consumer-double-voting`, or by a relayer that can be set to automatically detect consumer chain misbehaviors, e.g., [Hermes](https://github.com/informalsystems/hermes). @@ -779,7 +779,7 @@ the `chain_id` field is deprecated. Users should use `consumer_id` instead. You can use the `list-consumer-chains` query to get the list of all consumer chains and their consumer IDs. -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). +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). ```proto message MsgSubmitConsumerDoubleVoting { @@ -823,7 +823,7 @@ In the `EndBlock` of the provider module the following actions are performed: - Prune the no-longer needed public keys assigned by validators to use when validating on consumer chains. - Send validator updates to the consensus engine. The maximum number of validators is set through the [MaxProviderConsensusValidators](#maxproviderconsensusvalidators) param. -- At the begining of every epoch, +- At the beginning of every epoch, - for every launched consumer chain, compute the next consumer validator set and send it to the consumer chain via an IBC packet; - increment the VSC id. diff --git a/docs/docs/build/modules/03-consumer.md b/docs/docs/build/modules/03-consumer.md index 289ffb2bcb..9396389590 100644 --- a/docs/docs/build/modules/03-consumer.md +++ b/docs/docs/build/modules/03-consumer.md @@ -213,7 +213,7 @@ The consumer module is an IBC application that implements the [IBC module callba `OnChanOpenInit` first verifies that the CCV channel was not already created. Then, it validates the channel parameters -- an ordered IBC channel connected on the `consumer` port and with the counterparty port set to `provider` -- and asserts that the version matches the expected version -(only verions `1` is supported). +(only versions `1` is supported). Finally, it verifies that the underlying client is the expected client of the provider chain (i.e., provided in the consumer module genesis state). @@ -226,7 +226,7 @@ Finally, it verifies that the underlying client is the expected client of the pr `OnChanOpenAck` first verifies that the CCV channel was not already created. Then it verifies that the counterparty version matches the expected version -(only verions `1` is supported). +(only versions `1` is supported). If the verification passes, it stores the [ProviderFeePoolAddr](#providerfeepooladdrstr) in the state. @@ -313,7 +313,7 @@ In the `EndBlock` of the consumer module the following actions are performed: that was just upgraded to include the consumer module, then execute the [changeover logic](../../consumer-development/changeover-procedure.md). - Otherwise, distribute block rewards internally and once every [BlocksPerDistributionTransmission](#blocksperdistributiontransmission) send ICS rewards to the provider chain. -- Send slash packets to the provider chain reporting infractions validators commited on the consumer chain. +- Send slash packets to the provider chain reporting infractions validators committed on the consumer chain. - Send to the consensus engine validator updates reveived from the provider chain. ## Hooks diff --git a/docs/figures/hypha-consumer-start-process.excalidraw b/docs/figures/hypha-consumer-start-process.excalidraw index 72a1b05445..387ad9b059 100644 --- a/docs/figures/hypha-consumer-start-process.excalidraw +++ b/docs/figures/hypha-consumer-start-process.excalidraw @@ -6117,11 +6117,11 @@ "locked": false, "fontSize": 20, "fontFamily": 1, - "text": "Hz\nwe get the \nevidence and \nslash", + "text": "Hz\new get the \nevidence and \nslash", "textAlign": "center", "verticalAlign": "middle", "containerId": "V2uHp_TDQ8ihrS_8j9zZZ", - "originalText": "Hz\nwe get the evidence and slash", + "originalText": "Hz\new get the evidence and slash", "autoResize": true, "lineHeight": 1.25 }, @@ -7482,7 +7482,7 @@ "locked": false, "fontSize": 16, "fontFamily": 1, - "text": "height at which \nwe receive\nthe evidence", + "text": "height at which \new receive\nthe evidence", "textAlign": "center", "verticalAlign": "middle", "containerId": "s48-4wXmB4eSn25hza5zD", @@ -17350,11 +17350,11 @@ "locked": false, "fontSize": 16, "fontFamily": 1, - "text": "LC figures\nout that\nconsumer chain\nbecame\nunsecore on\ntimestamp T\n\nThen, LC would need to\n\"deactivate\"\nof all headers that\nhave timestamp >= T.\n\nWe can keep getting\nupdates but not use \ntheir Merkle root. ", + "text": "LC figures\nout that\nconsumer chain\nbecame\nunsecore on\ntimestamp T\n\nThen, LC would need to\n\"deactivate\"\nof all headers that\nhave timestamp >= T.\n\new can keep getting\nupdates but not use \ntheir Merkle root. ", "textAlign": "left", "verticalAlign": "top", "containerId": null, - "originalText": "LC figures\nout that\nconsumer chain\nbecame\nunsecore on\ntimestamp T\n\nThen, LC would need to\n\"deactivate\"\nof all headers that\nhave timestamp >= T.\n\nWe can keep getting\nupdates but not use \ntheir Merkle root. ", + "originalText": "LC figures\nout that\nconsumer chain\nbecame\nunsecore on\ntimestamp T\n\nThen, LC would need to\n\"deactivate\"\nof all headers that\nhave timestamp >= T.\n\new can keep getting\nupdates but not use \ntheir Merkle root. ", "autoResize": true, "lineHeight": 1.25 }, @@ -33824,11 +33824,11 @@ "locked": false, "fontSize": 16, "fontFamily": 1, - "text": "bogus header\n4. Febuary 2023\nsigned by Vm", + "text": "bogus header\n4. February 2023\nsigned by Vm", "textAlign": "center", "verticalAlign": "middle", "containerId": "dr-C5qJTTjNBk139hzYmq", - "originalText": "bogus header\n4. Febuary 2023\nsigned by Vm", + "originalText": "bogus header\n4. February 2023\nsigned by Vm", "autoResize": true, "lineHeight": 1.25 }, @@ -39079,11 +39079,11 @@ "locked": false, "fontSize": 36, "fontFamily": 1, - "text": "powers and consumer\npublic keys the validators\nhad when they actually\nopted in to a\nconsumer chain at the\nbeginning of an epoch\nCurrently used by consumer\nchain.\nWE STORE THOSE for\neach validator", + "text": "powers and consumer\npublic keys the validators\nhad when they actually\nopted in to a\nconsumer chain at the\nbeginning of an epoch\nCurrently used by consumer\nchain.\new STORE THOSE for\neach validator", "textAlign": "center", "verticalAlign": "top", "containerId": null, - "originalText": "powers and consumer\npublic keys the validators\nhad when they actually\nopted in to a\nconsumer chain at the\nbeginning of an epoch\nCurrently used by consumer\nchain.\nWE STORE THOSE for\neach validator", + "originalText": "powers and consumer\npublic keys the validators\nhad when they actually\nopted in to a\nconsumer chain at the\nbeginning of an epoch\nCurrently used by consumer\nchain.\new STORE THOSE for\neach validator", "autoResize": true, "lineHeight": 1.25 },