From af8b6afc4ed8145fa25e93fbdc5d779e14e1960d Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Thu, 26 Dec 2024 22:07:29 +0200 Subject: [PATCH] Fix typographical errors (#7799) * typos 00-intro.md * typo events.go * typo keys.go * typo keys.go * typo keys.go * typo genesis.go * typo genesis.go * typo merkle.go --------- Co-authored-by: Gjermund Garaba --- .../version-v9.0.x/01-ibc/05-upgrades/00-intro.md | 2 +- modules/apps/transfer/keeper/events.go | 2 +- modules/core/02-client/types/keys.go | 2 +- modules/core/03-connection/types/keys.go | 2 +- modules/core/04-channel/types/keys.go | 2 +- modules/core/23-commitment/types/merkle.go | 2 +- simapp/genesis.go | 2 +- testing/simapp/genesis.go | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/versioned_docs/version-v9.0.x/01-ibc/05-upgrades/00-intro.md b/docs/versioned_docs/version-v9.0.x/01-ibc/05-upgrades/00-intro.md index 61711d35f01..d9b8ef25fae 100644 --- a/docs/versioned_docs/version-v9.0.x/01-ibc/05-upgrades/00-intro.md +++ b/docs/versioned_docs/version-v9.0.x/01-ibc/05-upgrades/00-intro.md @@ -9,7 +9,7 @@ slug: /ibc/upgrades/intro This directory contains information on how to upgrade an IBC chain without breaking counterparty clients and connections. -IBC-connected chains must be able to upgrade without breaking connections to other chains. Otherwise there would be a massive disincentive towards upgrading and disrupting high-value IBC connections, thus preventing chains in the IBC ecosystem from evolving and improving. Many chain upgrades may be irrelevant to IBC, however some upgrades could potentially break counterparty clients if not handled correctly. Thus, any IBC chain that wishes to perform a IBC-client-breaking upgrade must perform an IBC upgrade in order to allow counterparty clients to securely upgrade to the new light client. +IBC-connected chains must be able to upgrade without breaking connections to other chains. Otherwise there would be a massive disincentive towards upgrading and disrupting high-value IBC connections, thus preventing chains in the IBC ecosystem from evolving and improving. Many chain upgrades may be irrelevant to IBC, however some upgrades could potentially break counterparty clients if not handled correctly. Thus, any IBC chain that wishes to perform an IBC-client-breaking upgrade must perform an IBC upgrade in order to allow counterparty clients to securely upgrade to the new light client. 1. The [quick-guide](./01-quick-guide.md) describes how IBC-connected chains can perform client-breaking upgrades and how relayers can securely upgrade counterparty clients using the SDK. 2. The [developer-guide](./02-developer-guide.md) is a guide for developers intending to develop IBC client implementations with upgrade functionality. diff --git a/modules/apps/transfer/keeper/events.go b/modules/apps/transfer/keeper/events.go index b797fcf1029..c30fdaabd9f 100644 --- a/modules/apps/transfer/keeper/events.go +++ b/modules/apps/transfer/keeper/events.go @@ -13,7 +13,7 @@ import ( channeltypes "github.com/cosmos/ibc-go/v9/modules/core/04-channel/types" ) -// EmitTransferEvent emits a ibc transfer event on successful transfers. +// EmitTransferEvent emits an ibc transfer event on successful transfers. func (k Keeper) EmitTransferEvent(ctx context.Context, sender, receiver string, tokens types.Tokens, memo string, forwardingHops []types.Hop) error { tokensStr := mustMarshalJSON(tokens) forwardingHopsStr := mustMarshalJSON(forwardingHops) diff --git a/modules/core/02-client/types/keys.go b/modules/core/02-client/types/keys.go index e0c23c96aaa..76ce77f08c7 100644 --- a/modules/core/02-client/types/keys.go +++ b/modules/core/02-client/types/keys.go @@ -35,7 +35,7 @@ const ( ) // FormatClientIdentifier returns the client identifier with the sequence appended. -// This is a SDK specific format not enforced by IBC protocol. +// This is an SDK specific format not enforced by IBC protocol. func FormatClientIdentifier(clientType string, sequence uint64) string { return fmt.Sprintf("%s-%d", clientType, sequence) } diff --git a/modules/core/03-connection/types/keys.go b/modules/core/03-connection/types/keys.go index ebea9087eb7..0eb2c756447 100644 --- a/modules/core/03-connection/types/keys.go +++ b/modules/core/03-connection/types/keys.go @@ -34,7 +34,7 @@ const ( ) // FormatConnectionIdentifier returns the connection identifier with the sequence appended. -// This is a SDK specific format not enforced by IBC protocol. +// This is an SDK specific format not enforced by IBC protocol. func FormatConnectionIdentifier(sequence uint64) string { return fmt.Sprintf("%s%d", ConnectionPrefix, sequence) } diff --git a/modules/core/04-channel/types/keys.go b/modules/core/04-channel/types/keys.go index 912582f0c8d..701c452d6d6 100644 --- a/modules/core/04-channel/types/keys.go +++ b/modules/core/04-channel/types/keys.go @@ -34,7 +34,7 @@ const ( ) // FormatChannelIdentifier returns the channel identifier with the sequence appended. -// This is a SDK specific format not enforced by IBC protocol. +// This is an SDK specific format not enforced by IBC protocol. func FormatChannelIdentifier(sequence uint64) string { return fmt.Sprintf("%s%d", ChannelPrefix, sequence) } diff --git a/modules/core/23-commitment/types/merkle.go b/modules/core/23-commitment/types/merkle.go index 9b6e4b0d073..5cdf72dddbd 100644 --- a/modules/core/23-commitment/types/merkle.go +++ b/modules/core/23-commitment/types/merkle.go @@ -11,7 +11,7 @@ import ( "github.com/cosmos/ibc-go/v9/modules/core/exported" ) -// var representing the proofspecs for a SDK chain +// var representing the proofspecs for an SDK chain var sdkSpecs = []*ics23.ProofSpec{ics23.IavlSpec, ics23.TendermintSpec} // ICS 023 Merkle Types Implementation diff --git a/simapp/genesis.go b/simapp/genesis.go index 69fa46b90ef..19328b3f2e0 100644 --- a/simapp/genesis.go +++ b/simapp/genesis.go @@ -5,7 +5,7 @@ import ( ) // GenesisState of the blockchain is represented here as a map of raw json -// messages key'd by a identifier string. +// messages key'd by an identifier string. // The identifier is used to determine which module genesis information belongs // to so it may be appropriately routed during init chain. // Within this application default genesis information is retrieved from diff --git a/testing/simapp/genesis.go b/testing/simapp/genesis.go index 69fa46b90ef..19328b3f2e0 100644 --- a/testing/simapp/genesis.go +++ b/testing/simapp/genesis.go @@ -5,7 +5,7 @@ import ( ) // GenesisState of the blockchain is represented here as a map of raw json -// messages key'd by a identifier string. +// messages key'd by an identifier string. // The identifier is used to determine which module genesis information belongs // to so it may be appropriately routed during init chain. // Within this application default genesis information is retrieved from