chore: fix spelling errors (#2307)

* chore: spelling errors fixes * revert some changes --------- Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: mpoke <[email protected]>
cosmos · Dec 11, 2024 · ea425d4 · ea425d4
1 parent bdadedb
commit ea425d4
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/docs/docs/adrs/adr-022-fault-resolutions.md b/docs/docs/adrs/adr-022-fault-resolutions.md
@@ -82,7 +82,7 @@ Additional states are added to the `provider` modules:
 ```
 
 ```protobuf
-    messsage {
+    message {
         // timestamp recording the last time a validator opted in to the consumer chain
         google.protobuf.Timestamp join_time = 1;
         // timestamp recording the last time a validator opted out of the consumer chain

diff --git a/scripts/test_doc/test_documentation.md b/scripts/test_doc/test_documentation.md
@@ -85,7 +85,7 @@
 |----------|-------------------|
  [TestRelayAndApplyDowntimePacket](../../tests/integration/slashing.go#L50) | TestRelayAndApplyDowntimePacket tests that downtime slash packets can be properly relayed from consumer to provider, handled by provider, with a VSC and jailing eventually effective on consumer and provider.<details><summary>Details</summary>* Set up CCV channels and retrieve consumer validators.<br>* Select a validator and create its consensus address.<br>* Retrieve the provider consensus address that corresponds to the consumer consensus address of the validator.<br>* The validator's current state is also retrieved, including its token balance,<br>* Set validator's signing information is to ensure it will be jailed for downtime.<br>* Create the slashing packet and send it from the consumer chain to the provider chain with a specified timeout.<br>* Receive the packet and verify that the validator was removed from the provider validator set.<br>* Relay VSC packets from the provider chain to each consumer chain and verify that the consumer chains correctly process these packets.<br>* Check the validator's balance and status on the provider chain to ensure it was jailed correctly but not slashed,<br>and its unjailing time is updated.<br>* Reset the outstanding downtime flag on the consumer chain, and ensure that the consumer<br>chain acknowledges receipt of the packet from the provider chain.<br><br>Note: This method does not test the actual slash packet sending logic for downtime<br>and double-signing, see TestValidatorDowntime and TestValidatorDoubleSigning for<br>those types of tests.</details> |
  [TestSlashPacketAcknowledgement](../../tests/integration/slashing.go#L185) | TestSlashPacketAcknowledgement tests the handling of a slash packet acknowledgement.<details><summary>Details</summary>* Set up a provider and consumer chain, with channel initialization between them performed.<br>* Send a slash packet with randomized fields from the consumer to the provider.<br>* The provider processes the packet</details> |
- [TestHandleSlashPacketDowntime](../../tests/integration/slashing.go#L236) | TestHandleSlashPacketDowntime tests the handling of a downtime related slash packet, with integration tests.<details><summary>Details</summary>* Retrieve a validator from provider chain's validators and checks if it's bonded.<br>* Set tThe signing information for the validator.<br>* The provider processes the downtime slashing packet from the consumer.<br>* Check that the validator has been jailed as a result of the downtime slashing packet being processed.<br>* Verify that the validator’s signing information is updated and that the jailing duration is set correctly.<br><br>Note that only downtime slash packets are processed by HandleSlashPacket.</details> |
+ [TestHandleSlashPacketDowntime](../../tests/integration/slashing.go#L236) | TestHandleSlashPacketDowntime tests the handling of a downtime related slash packet, with integration tests.<details><summary>Details</summary>* Retrieve a validator from provider chain's validators and checks if it's bonded.<br>* Set the signing information for the validator.<br>* The provider processes the downtime slashing packet from the consumer.<br>* Check that the validator has been jailed as a result of the downtime slashing packet being processed.<br>* Verify that the validator’s signing information is updated and that the jailing duration is set correctly.<br><br>Note that only downtime slash packets are processed by HandleSlashPacket.</details> |
  [TestOnRecvSlashPacketErrors](../../tests/integration/slashing.go#L283) | TestOnRecvSlashPacketErrors tests errors for the OnRecvSlashPacket method in an integration testing setting.<details><summary>Details</summary>* Set up all CCV channels and expect panic if the channel is not established via dest channel of packet.<br>* After the correct channelID is added to the packet, a panic shouldn't occur anymore.<br>* Create an instance of SlashPacketData and then verify correct processing and error handling<br>for slashing packets received by the provider chain.<br>TODO: Move to unit tests.</details> |
  [TestValidatorDowntime](../../tests/integration/slashing.go#L412) | TestValidatorDowntime tests if a slash packet is sent and if the outstanding slashing flag is switched when a validator has downtime on the slashing module.<details><summary>Details</summary>* Set up all CCV channel and send an empty VSC packet, then retrieve the address of a validator.<br>* Validator signs blocks for the duration of the signedBlocksWindow and a slash packet is constructed to be sent and committed.<br>* Simulate the validator missing blocks and then verify that the validator is jailed and the jailed time is correctly updated.<br>* Ensure that the missed block counters are reset.<br>* Check that there is a pending slash packet in the queue, and then send the pending packets.<br>* Check if slash record is created and verify that the consumer queue still contains the packet since no<br>acknowledgment has been received from the provider.<br>* Verify that the slash packet was sent and check that the outstanding slashing flag prevents the jailed validator to keep missing block.</details> |
  [TestQueueAndSendSlashPacket](../../tests/integration/slashing.go#L533) | TestQueueAndSendSlashPacket tests the integration of QueueSlashPacket with SendPackets. In normal operation slash packets are queued in BeginBlock and sent in EndBlock.<details><summary>Details</summary>* Set up all CCV channels and then queue slash packets for both downtime and double-signing infractions.<br>* Check that the correct number of slash requests are stored in the queue, including duplicates for downtime infractions.<br>* Prepare the CCV channel for sending actual slash packets.<br>* Send the slash packets and check that the outstanding downtime flags are correctly set for validators that were slashed<br>for downtime infractions.<br>* Ensure that the pending data packets queue is empty.<br>TODO: Move to unit tests.</details> |

diff --git a/tests/integration/slashing.go b/tests/integration/slashing.go
@@ -227,7 +227,7 @@ func (s *CCVTestSuite) TestSlashPacketAcknowledgement() {
 // TestHandleSlashPacketDowntime tests the handling of a downtime related slash packet, with integration tests.
 // @Long Description@
 // * Retrieve a validator from provider chain's validators and checks if it's bonded.
-// * Set tThe signing information for the validator.
+// * Set the signing information for the validator.
 // * The provider processes the downtime slashing packet from the consumer.
 // * Check that the validator has been jailed as a result of the downtime slashing packet being processed.
 // * Verify that the validator’s signing information is updated and that the jailing duration is set correctly.

diff --git a/tests/interchain/provider_single_val_test.go b/tests/interchain/provider_single_val_test.go
@@ -189,7 +189,7 @@ func (s *SingleValidatorProviderSuite) TestProviderValidatorOptInWithKeyAssignme
 	s.Require().Equal(1, len(optInVals.ValidatorsProviderAddresses))
 	s.Require().Equal(valProviderAddress, optInVals.ValidatorsProviderAddresses[0])
 
-	// assgin custom consumer consensus key
+	// assign custom consumer consensus key
 	s.Require().NoError(s.Provider.AssignKey(s.GetContext(), consumerChain.ConsumerID, 0, valConsumerKey))
 	consumerKeyAddr, err := s.Provider.ValidatorConsumerAddress(s.GetContext(), consumerChain.ConsumerID, valProviderAddress)
 	s.Require().NoError(err)
@@ -249,7 +249,7 @@ func (s *SingleValidatorProviderSuite) TestProviderUpdateConsumer() {
 	s.Require().NoError(s.Provider.OptIn(s.GetContext(), consumerChain.ConsumerID, 0))
 	s.Require().Equal(providertypes.CONSUMER_PHASE_REGISTERED.String(), consumerChain.Phase)
 
-	// updated consumer with the minimum params (metadata) - regeistered phase
+	// updated consumer with the minimum params (metadata) - registered phase
 	upgradeMsg := &providertypes.MsgUpdateConsumer{
 		Owner:                    testAcc,
 		ConsumerId:               consumerChain.ConsumerID,
@@ -601,7 +601,7 @@ func (s *SingleValidatorProviderSuite) TestProviderOwnerChecks() {
 	s.Require().Error(err)
 	s.Require().Contains(err.Error(), "expected gov account")
 
-	// update owner using msg submited by the current owner
+	// update owner using msg submitted by the current owner
 	s.Require().NoError(s.Provider.UpdateConsumer(s.GetContext(), upgradeMsg, testAccKey2))
 
 	// update to top N using proposal
@@ -652,7 +652,7 @@ func (s *SingleValidatorProviderSuite) TestInfractionParameters() {
 	s.Require().NoError(testutil.WaitForBlocks(s.GetContext(), 1, s.Provider))
 	consumerChain, err = s.Provider.GetConsumerChain(s.GetContext(), consumerId)
 	s.Require().NoError(err)
-	// chain is in pre-launched phase, params are updated immediatelly
+	// chain is in pre-launched phase, params are updated immediately
 	s.Require().Equal(infractionParamsTemplate(), convertJsonToInfractionParameters(consumerChain.InfractionParams))
 
 	// Confirm that a chain can be created with custom infraction parameters set only for double sign