diff --git a/CHANGELOG.md b/CHANGELOG.md index ed27da48a7d..cfa7d0540c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -425,7 +425,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ * (apps/27-interchain-accounts) [\#2290](https://github.com/cosmos/ibc-go/pull/2290) Changed `DefaultParams` function in `host` submodule to allow all messages by default. Defined a constant named `AllowAllHostMsgs` for `host` module to keep wildcard "*" string which allows all messages. * (apps/27-interchain-accounts) [\#2297](https://github.com/cosmos/ibc-go/pull/2297) Adding cli command to generate ICS27 packet data. * (modules/core/keeper) [\#1728](https://github.com/cosmos/ibc-go/pull/2399) Updated channel callback errors to include portID & channelID for better identification of errors. -* (testing) [\#2657](https://github.com/cosmos/ibc-go/pull/2657) Carry `ProposerAddress` through commited blocks. Allow `DefaultGenTxGas` to be modified. +* (testing) [\#2657](https://github.com/cosmos/ibc-go/pull/2657) Carry `ProposerAddress` through committed blocks. Allow `DefaultGenTxGas` to be modified. * (core/03-connection) [\#2745](https://github.com/cosmos/ibc-go/pull/2745) Adding `ConnectionParams` grpc query and CLI to 03-connection. * (apps/29-fee) [\#2786](https://github.com/cosmos/ibc-go/pull/2786) Save gas by checking key existence with `KVStore`'s `Has` method. @@ -531,11 +531,11 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements * (27-interchain-accounts) [\#1352](https://github.com/cosmos/ibc-go/pull/1352) Add support for Cosmos-SDK simulation to ics27 module. -* (linting) [\#1418](https://github.com/cosmos/ibc-go/pull/1418) Fix linting errors, resulting compatiblity with go1.18 linting style, golangci-lint 1.46.2 and the revivie linter. This caused breaking changes in core/04-channel, core/ante, and the testing library. +* (linting) [\#1418](https://github.com/cosmos/ibc-go/pull/1418) Fix linting errors, resulting compatibility with go1.18 linting style, golangci-lint 1.46.2 and the revivie linter. This caused breaking changes in core/04-channel, core/ante, and the testing library. ### Features -* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpont to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. +* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpoint to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. ### Bug Fixes @@ -689,7 +689,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Features -* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpont to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. +* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpoint to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. ### Bug Fixes @@ -792,7 +792,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Features -* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpont to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. +* (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpoint to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses. ### Bug Fixes @@ -1410,7 +1410,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements * (04-channel) [\#220](https://github.com/cosmos/ibc-go/pull/220) Channel handshake events are now emitted with the channel keeper. -* (core/02-client) [\#205](https://github.com/cosmos/ibc-go/pull/205) Add in-place and genesis migrations from SDK v0.42.0 to ibc-go v1.0.0. Solo machine protobuf defintions are migrated from v1 to v2. All solo machine consensus states are pruned. All expired tendermint consensus states are pruned. +* (core/02-client) [\#205](https://github.com/cosmos/ibc-go/pull/205) Add in-place and genesis migrations from SDK v0.42.0 to ibc-go v1.0.0. Solo machine protobuf definitions are migrated from v1 to v2. All solo machine consensus states are pruned. All expired tendermint consensus states are pruned. * (modules/core) [\#184](https://github.com/cosmos/ibc-go/pull/184) Improve error messages. Uses unique error codes to indicate already relayed packets. * (07-tendermint) [\#182](https://github.com/cosmos/ibc-go/pull/182) Remove duplicate checks in upgrade logic. * (modules/core/04-channel) [\#7949](https://github.com/cosmos/cosmos-sdk/issues/7949) Standardized channel `Acknowledgement` moved to its own file. Codec registration redundancy removed. diff --git a/RELEASES.md b/RELEASES.md index ae444fa8e99..c108b2e72e9 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -33,7 +33,7 @@ Alpha releases are intended to make available new features as soon as they are f Initial users of alpha releases are expected to be advanced, patient, and capable of handling unusual errors. Very basic integration testing will be performed by the ibc-go development team before alpha releases. -An internal audit is typically performed before the alpha release allowing the development team to guage the maturity and stability of changes included in the next release. +An internal audit is typically performed before the alpha release allowing the development team to gauge the maturity and stability of changes included in the next release. ### Beta diff --git a/cliff.toml b/cliff.toml index c29518f5bbf..da5a41a196f 100644 --- a/cliff.toml +++ b/cliff.toml @@ -63,7 +63,7 @@ filter_unconventional = true split_commits = true # regex for preprocessing the commit messages commit_preprocessors = [ - # A reference to an issue is appened to commits that looks like "(#1234)", this will be replaced + # A reference to an issue is appended to commits that looks like "(#1234)", this will be replaced # with a link to that issue, e.g. "[#$1234](https://github.com/cosmos/ibc-go/issues/1234)". { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/cosmos/ibc-go/issues/${2}))" }, # any reference to a pr like "pr-1234" will be replaced with a link to the PR. diff --git a/cmd/build_test_matrix/main.go b/cmd/build_test_matrix/main.go index 898b3255c72..c2bee6d7050 100644 --- a/cmd/build_test_matrix/main.go +++ b/cmd/build_test_matrix/main.go @@ -17,7 +17,7 @@ const ( testNamePrefix = "Test" testFileNameSuffix = "_test.go" e2eTestDirectory = "e2e" - // testEntryPointEnv specifes a single test function to run if provided. + // testEntryPointEnv specifies a single test function to run if provided. testEntryPointEnv = "TEST_ENTRYPOINT" // testExclusionsEnv is a comma separated list of test function names that will not be included // in the results of this script. diff --git a/docs/architecture/adr-007-solomachine-signbytes.md b/docs/architecture/adr-007-solomachine-signbytes.md index 7407867e44e..b65361174d1 100644 --- a/docs/architecture/adr-007-solomachine-signbytes.md +++ b/docs/architecture/adr-007-solomachine-signbytes.md @@ -10,7 +10,7 @@ Accepted, applied in v7 ## Context -The `06-solomachine` implemention up until ibc-go v7 constructed sign bytes using a `DataType` which described what type of data was being signed. +The `06-solomachine` implementation up until ibc-go v7 constructed sign bytes using a `DataType` which described what type of data was being signed. This design decision arose from a misunderstanding of the security implications. It was noted that the proto definitions do not [provide uniqueness](https://github.com/cosmos/cosmos-sdk/pull/7237#discussion_r484264573) which is a necessity for ensuring two signatures over different data types can never be the same. What was missed is that the uniqueness is not provided by the proto definition, but by the usage of the proto definition. diff --git a/docs/architecture/adr-015-ibc-packet-receiver.md b/docs/architecture/adr-015-ibc-packet-receiver.md index d9d673a8470..48ebe1be757 100644 --- a/docs/architecture/adr-015-ibc-packet-receiver.md +++ b/docs/architecture/adr-015-ibc-packet-receiver.md @@ -96,7 +96,7 @@ func (pvr ProofVerificationDecorator) AnteHandle(ctx Context, tx Tx, simulate bo err = pvr.clientKeeper.UpdateClient(msg.ClientID, msg.Header) case channel.MsgPacket: err = pvr.channelKeeper.RecvPacket(msg.Packet, msg.Proofs, msg.ProofHeight) - case chanel.MsgAcknowledgement: + case channel.MsgAcknowledgement: err = pvr.channelKeeper.AcknowledgementPacket(msg.Acknowledgement, msg.Proof, msg.ProofHeight) case channel.MsgTimeoutPacket: err = pvr.channelKeeper.TimeoutPacket(msg.Packet, msg.Proof, msg.ProofHeight, msg.NextSequenceRecv) diff --git a/docs/architecture/adr.template.md b/docs/architecture/adr.template.md index 7081756339c..630c3c6cdc6 100644 --- a/docs/architecture/adr.template.md +++ b/docs/architecture/adr.template.md @@ -33,6 +33,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} diff --git a/docs/client/swagger-ui/swagger.yaml b/docs/client/swagger-ui/swagger.yaml index 808a6fbfedd..aeb0edbb78f 100644 --- a/docs/client/swagger-ui/swagger.yaml +++ b/docs/client/swagger-ui/swagger.yaml @@ -5887,7 +5887,7 @@ paths: format: uint64 - name: latest_height description: >- - latest_height overrrides the height field and queries the latest + latest_height overrides the height field and queries the latest stored ConsensusState. @@ -7189,7 +7189,7 @@ paths: identifier description: >- Version defines the versioning scheme used to - negotiate the IBC verison in + negotiate the IBC version in the connection handshake. title: >- @@ -7598,7 +7598,7 @@ paths: identifier description: >- Version defines the versioning scheme used to negotiate - the IBC verison in + the IBC version in the connection handshake. description: >- @@ -15238,7 +15238,7 @@ definitions: format: uint64 title: packet sequence title: |- - PacketId is an identifer for a unique Packet + PacketId is an identifier for a unique Packet Source chains refer to packets by source port/channel Destination chains refer to packets by destination port/channel ibc.core.client.v1.ConsensusStateWithHeight: @@ -17028,7 +17028,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. description: >- @@ -17150,7 +17150,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. title: >- @@ -17735,7 +17735,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. description: >- @@ -17872,7 +17872,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the - IBC verison in + IBC version in the connection handshake. title: >- @@ -18018,7 +18018,7 @@ definitions: type: string title: list of features compatible with the specified identifier description: |- - Version defines the versioning scheme used to negotiate the IBC verison in + Version defines the versioning scheme used to negotiate the IBC version in the connection handshake. ibc.core.channel.v1.Channel: type: object diff --git a/docs/dev/pull-requests.md b/docs/dev/pull-requests.md index c8db90f5049..9115770a7bd 100644 --- a/docs/dev/pull-requests.md +++ b/docs/dev/pull-requests.md @@ -4,7 +4,7 @@ If the PR is the result of a related GitHub issue, please include `closes: #` in the PR’s description in order to auto-close the related issue once the PR is merged. This will also link the issue and the PR together so that if anyone looks at either in the future, they won’t have any problem trying to find the corresponding issue/PR as it will be recorded in the sidebar. -If the PR is not the result of an existing issue and it fixes a bug, please provide a detailed description of the bug. For feature addtions, we recommend opening an issue first and have it discussed and agreed upon, before working on it and opening a PR. +If the PR is not the result of an existing issue and it fixes a bug, please provide a detailed description of the bug. For feature additions, we recommend opening an issue first and have it discussed and agreed upon, before working on it and opening a PR. If possible, [tick the "Allow edits from maintainers" box](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) when opening your PR from your fork of ibc-go. This allows us to directly make minor edits / refactors and speeds up the merging process. diff --git a/docs/dev/release-management.md b/docs/dev/release-management.md index ec366d84bbf..fb188df867e 100644 --- a/docs/dev/release-management.md +++ b/docs/dev/release-management.md @@ -7,7 +7,7 @@ Pre-requisites for creating a release branch for a new major version: 1. Bump [Go package version](https://github.com/cosmos/ibc-go/blob/main/go.mod#L3). 2. Change all imports. For example: if the next major version is `v3`, then change all imports starting with `github.com/cosmos/ibc-go/v2` to `github.com/cosmos/ibc-go/v3`). -Once the above pre-requisites are satified: +Once the above pre-requisites are satisfied: 1. Start on `main`. 2. Create the release branch (`release/vX.XX.X`). For example: `release/v3.0.x`. diff --git a/docs/docs/01-ibc/03-apps/03-bindports.md b/docs/docs/01-ibc/03-apps/03-bindports.md index 4bd85d29bc5..6a3cc27a924 100644 --- a/docs/docs/01-ibc/03-apps/03-bindports.md +++ b/docs/docs/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ func (gs GenesisState) Validate() error { if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/docs/01-ibc/04-middleware/02-develop.md b/docs/docs/01-ibc/04-middleware/02-develop.md index 3d37491d03c..5ce750058e1 100644 --- a/docs/docs/01-ibc/04-middleware/02-develop.md +++ b/docs/docs/01-ibc/04-middleware/02-develop.md @@ -15,7 +15,7 @@ The interfaces a middleware must implement are found [here](https://github.com/c ```go // Middleware implements the ICS26 Module interface type Middleware interface { - IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` @@ -348,7 +348,7 @@ See [here](https://github.com/cosmos/ibc-go/blob/v7.0.0/modules/apps/29-fee/ibc_ Middleware must also wrap ICS-04 so that any communication from the application to the `channelKeeper` goes through the middleware first. Similar to the packet callbacks, the middleware may modify outgoing acknowledgements and packets in any way it wishes. -To ensure optimal generalisability, the `ICS4Wrapper` abstraction serves to abstract away whether a middleware is the topmost middleware (and thus directly caling into the ICS-04 `channelKeeper`) or itself being wrapped by another middleware. +To ensure optimal generalisability, the `ICS4Wrapper` abstraction serves to abstract away whether a middleware is the topmost middleware (and thus directly calling into the ICS-04 `channelKeeper`) or itself being wrapped by another middleware. Remember that middleware can be stateful or stateless. When defining the stateful middleware's keeper, the `ics4Wrapper` field is included. Then the appropriate keeper can be passed when instantiating the middleware's keeper in `app.go` diff --git a/docs/docs/02-apps/02-interchain-accounts/02-development.md b/docs/docs/02-apps/02-interchain-accounts/02-development.md index 720527b4693..c42696cc514 100644 --- a/docs/docs/02-apps/02-interchain-accounts/02-development.md +++ b/docs/docs/02-apps/02-interchain-accounts/02-development.md @@ -25,7 +25,7 @@ It may be desirable to allow smart contracts to control an interchain account. To facilitate such an action, the controller submodule may be provided an underlying application which redirects to smart contract callers. An improved design has been suggested in [ADR 008](https://github.com/cosmos/ibc-go/pull/1976) which performs this action via middleware. -Implementors of this use case are recommended to follow the ADR 008 approach. +Implementers of this use case are recommended to follow the ADR 008 approach. The underlying application may continue to be used as a short term solution for ADR 008 and the [legacy API](03-auth-modules.md#registerinterchainaccount) should continue to be utilized in such situations. ## Packet callbacks diff --git a/docs/docs/02-apps/02-interchain-accounts/05-messages.md b/docs/docs/02-apps/02-interchain-accounts/05-messages.md index 119c740e03e..e94dc7c41fc 100644 --- a/docs/docs/02-apps/02-interchain-accounts/05-messages.md +++ b/docs/docs/02-apps/02-interchain-accounts/05-messages.md @@ -10,7 +10,7 @@ slug: /apps/interchain-accounts/messages ## `MsgRegisterInterchainAccount` -An Interchain Accounts channel handshake can be initated using `MsgRegisterInterchainAccount`: +An Interchain Accounts channel handshake can be initiated using `MsgRegisterInterchainAccount`: ```go type MsgRegisterInterchainAccount struct { diff --git a/docs/docs/02-apps/02-interchain-accounts/08-client.md b/docs/docs/02-apps/02-interchain-accounts/08-client.md index c7c50d09d82..023495a2aec 100644 --- a/docs/docs/02-apps/02-interchain-accounts/08-client.md +++ b/docs/docs/02-apps/02-interchain-accounts/08-client.md @@ -87,7 +87,7 @@ simd tx interchain-accounts host --help ##### `generate-packet-data` -The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be uesd to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. +The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be used to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. ```shell simd tx interchain-accounts host generate-packet-data [message] diff --git a/docs/docs/03-light-clients/01-developer-guide/09-setup.md b/docs/docs/03-light-clients/01-developer-guide/09-setup.md index f3bba760ec2..904a53262d1 100644 --- a/docs/docs/03-light-clients/01-developer-guide/09-setup.md +++ b/docs/docs/03-light-clients/01-developer-guide/09-setup.md @@ -53,7 +53,7 @@ func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage { return nil } -// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light cilent. +// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light client. func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error { return nil } diff --git a/docs/docs/03-light-clients/04-wasm/07-contracts.md b/docs/docs/03-light-clients/04-wasm/07-contracts.md index fc46344444f..2c8c8e84028 100644 --- a/docs/docs/03-light-clients/04-wasm/07-contracts.md +++ b/docs/docs/03-light-clients/04-wasm/07-contracts.md @@ -52,7 +52,7 @@ pub enum QueryMsg { } ``` -To learn what it is expected from the Wasm light client contract when processing each message, please read the corresponsing section of the [Light client developer guide](../01-developer-guide/01-overview.md): +To learn what it is expected from the Wasm light client contract when processing each message, please read the corresponding section of the [Light client developer guide](../01-developer-guide/01-overview.md): - For `StatusMsg`, see the section [`Status` method](../01-developer-guide/02-client-state.md#status-method). - For `ExportMetadataMsg`, see the section [Genesis metadata](../01-developer-guide/08-genesis.md#genesis-metadata). @@ -89,7 +89,7 @@ pub enum SudoMsg { } ``` -To learn what it is expected from the Wasm light client contract when processing each message, please read the corresponsing section of the [Light client developer guide](../01-developer-guide/01-overview.md): +To learn what it is expected from the Wasm light client contract when processing each message, please read the corresponding section of the [Light client developer guide](../01-developer-guide/01-overview.md): - For `UpdateStateMsg`, see the section [`UpdateState`](../01-developer-guide/04-updates-and-misbehaviour.md#updatestate). - For `UpdateStateOnMisbehaviourMsg`, see the section [`UpdateStateOnMisbehaviour`](../01-developer-guide/04-updates-and-misbehaviour.md#updatestateonmisbehaviour). @@ -100,7 +100,7 @@ To learn what it is expected from the Wasm light client contract when processing ### Migration -The `08-wasm` proxy light client exposes the `MigrateContract` RPC endpoint that can be used to migrate a given Wasm light client contract (specified by the client identifier) to a new Wasm byte code (specified by the hash of the byte code). The expected use case for this RPC endpoint is to enable contracts to migrate to new byte code in case the current byte code is found to have a bug or vulnerability. The Wasm byte code that contracts are migrated have to be uploaded beforehand using `MsgStoreCode` and must implement the `migrate` entry point. See section[`MsgMigrateContract`](./04-messages.md#msgmigratecontract) for information about the request messsage for this RPC endpoint. +The `08-wasm` proxy light client exposes the `MigrateContract` RPC endpoint that can be used to migrate a given Wasm light client contract (specified by the client identifier) to a new Wasm byte code (specified by the hash of the byte code). The expected use case for this RPC endpoint is to enable contracts to migrate to new byte code in case the current byte code is found to have a bug or vulnerability. The Wasm byte code that contracts are migrated have to be uploaded beforehand using `MsgStoreCode` and must implement the `migrate` entry point. See section[`MsgMigrateContract`](./04-messages.md#msgmigratecontract) for information about the request message for this RPC endpoint. ## Expected behaviour diff --git a/docs/docs/04-middleware/01-ics29-fee/03-msgs.md b/docs/docs/04-middleware/01-ics29-fee/03-msgs.md index 4496df29f98..d1b26238a17 100644 --- a/docs/docs/04-middleware/01-ics29-fee/03-msgs.md +++ b/docs/docs/04-middleware/01-ics29-fee/03-msgs.md @@ -25,7 +25,7 @@ type MsgPayPacketFee struct{ Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/docs/05-migrations/06-v4-to-v5.md b/docs/docs/05-migrations/06-v4-to-v5.md index d5055d5006a..c5e8c84db1c 100644 --- a/docs/docs/05-migrations/06-v4-to-v5.md +++ b/docs/docs/05-migrations/06-v4-to-v5.md @@ -286,7 +286,7 @@ default: // for SDK 0.45 and below } ``` -See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corrresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). +See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). ### ICS29 - Fee Middleware diff --git a/docs/requirements/ics29-v1-requirements.md b/docs/requirements/ics29-v1-requirements.md index ddbf9a475cb..6af639939a8 100644 --- a/docs/requirements/ics29-v1-requirements.md +++ b/docs/requirements/ics29-v1-requirements.md @@ -85,7 +85,7 @@ See section [Definitions](https://github.com/cosmos/ibc/tree/main/spec/app/ics-0 | 4.06 | The next sequence packet may be incentivized by multiple account addresses. | [Acceptance test](https://github.com/cosmos/ibc-go/blob/v4.0.0/modules/apps/29-fee/keeper/msg_server_test.go#L183) | `Verified` | | 4.07 | The next sequence packet shall only be incentivized with valid coin denominations. | [Acceptance test](https://github.com/cosmos/ibc-go/blob/v4.0.0/modules/apps/29-fee/keeper/msg_server_test.go#L246-L266) | `Verified` | -#### Aynchronously +#### Asynchronously | ID | Description | Verification | Status | | --- | ----------- | ------------ | ------ | diff --git a/docs/requirements/localhost-requirements.md b/docs/requirements/localhost-requirements.md index f467099ab09..98bdd44c066 100644 --- a/docs/requirements/localhost-requirements.md +++ b/docs/requirements/localhost-requirements.md @@ -66,4 +66,4 @@ Polymer plans to leverage the localhost client with multiple connections as part | ID | Description | Verification | Status | Release | | -- | ----------- | ------------ | ------ | ------- | -| 3.01 | Existing CLI interfaces used with IBC application modules shall be useable with the localhost client. | Manual test | `Verified` | v7.1.0 | +| 3.01 | Existing CLI interfaces used with IBC application modules shall be usable with the localhost client. | Manual test | `Verified` | v7.1.0 | diff --git a/docs/versioned_docs/version-v4.5.x/01-ibc/02-integration.md b/docs/versioned_docs/version-v4.5.x/01-ibc/02-integration.md index 60bedf7e216..f1d849ee7d6 100644 --- a/docs/versioned_docs/version-v4.5.x/01-ibc/02-integration.md +++ b/docs/versioned_docs/version-v4.5.x/01-ibc/02-integration.md @@ -17,7 +17,7 @@ send fungible token transfers to other chains. ## Integrating the IBC module -Integrating the IBC module to your SDK-based application is straighforward. The general changes can be summarized in the following steps: +Integrating the IBC module to your SDK-based application is straightforward. The general changes can be summarized in the following steps: - Add required modules to the `module.BasicManager` - Define additional `Keeper` fields for the new modules on the `App` type @@ -178,7 +178,7 @@ One addition from IBC is the concept of `HistoricalEntries` which are stored on Each entry contains the historical information for the `Header` and `ValidatorSet` of this chain which is stored at each height during the `BeginBlock` call. The historical info is required to introspect the past historical info at any given height in order to verify the light client `ConsensusState` during the -connection handhake. +connection handshake. The IBC module also has [`BeginBlock`](https://github.com/cosmos/ibc-go/blob/main/modules/core/02-client/abci.go) logic as well. This is optional as it is only required if your application uses the localhost client to connect two different modules from the same chain. diff --git a/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/02-ibcmodule.md b/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/02-ibcmodule.md index ce96fbe4778..a65c71c074c 100644 --- a/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/02-ibcmodule.md +++ b/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/02-ibcmodule.md @@ -207,7 +207,7 @@ a subset of features supported by your application for that version. The struct scheme can be found in [03-connection/types](https://github.com/cosmos/ibc-go/blob/main/modules/core/03-connection/types/version.go#L16). Since the version type is a string, applications have the ability to do simple version verification -via string matching or they can use the already impelemented versioning system and pass the proto +via string matching or they can use the already implemented versioning system and pass the proto encoded version into each handhshake call as necessary. ICS20 currently implements basic string matching with a single supported version. diff --git a/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/03-bindports.md b/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/03-bindports.md index a57ec4c6000..d3b4cc6169c 100644 --- a/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/03-bindports.md +++ b/docs/versioned_docs/version-v4.5.x/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ Currently, ports must be bound on app initialization. In order to bind modules t if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/versioned_docs/version-v4.5.x/01-ibc/04-middleware/01-develop.md b/docs/versioned_docs/version-v4.5.x/01-ibc/04-middleware/01-develop.md index 27304558b5f..9eb5b42ee09 100644 --- a/docs/versioned_docs/version-v4.5.x/01-ibc/04-middleware/01-develop.md +++ b/docs/versioned_docs/version-v4.5.x/01-ibc/04-middleware/01-develop.md @@ -46,7 +46,7 @@ IBC middleware will wrap over an underlying IBC application and sits between cor ```go // Middleware implements the ICS26 Module interface type Middleware interface { - porttypes.IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + porttypes.IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ics4Wrapper: ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` diff --git a/docs/versioned_docs/version-v4.5.x/01-ibc/09-roadmap.md b/docs/versioned_docs/version-v4.5.x/01-ibc/09-roadmap.md index d6c56680f91..94a9b9b086a 100644 --- a/docs/versioned_docs/version-v4.5.x/01-ibc/09-roadmap.md +++ b/docs/versioned_docs/version-v4.5.x/01-ibc/09-roadmap.md @@ -7,7 +7,7 @@ slug: /roadmap/roadmap # Roadmap ibc-go -*Lastest update: March 31, 2022* +*Last update: March 31, 2022* This document endeavours to inform the wider IBC community about plans and priorities for work on ibc-go by the team at Interchain GmbH. It is intended to broadly inform all users of ibc-go, including developers and operators of IBC, relayer, chain and wallet applications. @@ -20,8 +20,8 @@ At a high level we will focus on: - Finishing the implementation of [relayer incentivisation](https://github.com/orgs/cosmos/projects/7/views/8). - Finishing the [refactoring of 02-client](https://github.com/cosmos/ibc-go/milestone/16). - Finishing the upgrade to Cosmos SDK v0.46 and Tendermint v0.35. -- Implementing and testing the changes needed to support the [transtion to SMT storage](https://github.com/cosmos/ibc-go/milestone/21) in the Cosmos SDK. -- Desiging the implementation and scoping the engineering work for [channel upgradability](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics/UPGRADES.md). +- Implementing and testing the changes needed to support the [transition to SMT storage](https://github.com/cosmos/ibc-go/milestone/21) in the Cosmos SDK. +- Designing the implementation and scoping the engineering work for [channel upgradability](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics/UPGRADES.md). - Improving the project's documentation and writing guides for [light client](https://github.com/cosmos/ibc-go/issues/59) and middleware implementation. - Working on [core backlog issues](https://github.com/cosmos/ibc-go/milestone/8). - Spending time on expanding and deepening our knowledge of IBC, but also other parts of the Cosmos stack. diff --git a/docs/versioned_docs/version-v4.5.x/03-middleware/01-ics29-fee/03-msgs.md b/docs/versioned_docs/version-v4.5.x/03-middleware/01-ics29-fee/03-msgs.md index 02d648c27f1..7fc2cd2da04 100644 --- a/docs/versioned_docs/version-v4.5.x/03-middleware/01-ics29-fee/03-msgs.md +++ b/docs/versioned_docs/version-v4.5.x/03-middleware/01-ics29-fee/03-msgs.md @@ -25,7 +25,7 @@ The fee middleware module exposes two different ways to pay fees for relaying IB Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/versioned_docs/version-v4.5.x/04-migrations/01-support-denoms-with-slashes.md b/docs/versioned_docs/version-v4.5.x/04-migrations/01-support-denoms-with-slashes.md index 5dc6b10d04e..54bbd96227e 100644 --- a/docs/versioned_docs/version-v4.5.x/04-migrations/01-support-denoms-with-slashes.md +++ b/docs/versioned_docs/version-v4.5.x/04-migrations/01-support-denoms-with-slashes.md @@ -4,7 +4,7 @@ sidebar_label: Support transfer of coins whose base denom contains slashes sidebar_position: 1 slug: /migrations/support-denoms-with-slashes --- -# Migrating from not supporing base denoms with slashes to supporting base denoms with slashes +# Migrating from not supporting base denoms with slashes to supporting base denoms with slashes This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG. Any changes that must be done by a user of ibc-go should be documented here. diff --git a/docs/versioned_docs/version-v5.3.x/01-ibc/02-integration.md b/docs/versioned_docs/version-v5.3.x/01-ibc/02-integration.md index 60bedf7e216..f1d849ee7d6 100644 --- a/docs/versioned_docs/version-v5.3.x/01-ibc/02-integration.md +++ b/docs/versioned_docs/version-v5.3.x/01-ibc/02-integration.md @@ -17,7 +17,7 @@ send fungible token transfers to other chains. ## Integrating the IBC module -Integrating the IBC module to your SDK-based application is straighforward. The general changes can be summarized in the following steps: +Integrating the IBC module to your SDK-based application is straightforward. The general changes can be summarized in the following steps: - Add required modules to the `module.BasicManager` - Define additional `Keeper` fields for the new modules on the `App` type @@ -178,7 +178,7 @@ One addition from IBC is the concept of `HistoricalEntries` which are stored on Each entry contains the historical information for the `Header` and `ValidatorSet` of this chain which is stored at each height during the `BeginBlock` call. The historical info is required to introspect the past historical info at any given height in order to verify the light client `ConsensusState` during the -connection handhake. +connection handshake. The IBC module also has [`BeginBlock`](https://github.com/cosmos/ibc-go/blob/main/modules/core/02-client/abci.go) logic as well. This is optional as it is only required if your application uses the localhost client to connect two different modules from the same chain. diff --git a/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/02-ibcmodule.md b/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/02-ibcmodule.md index ce96fbe4778..a65c71c074c 100644 --- a/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/02-ibcmodule.md +++ b/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/02-ibcmodule.md @@ -207,7 +207,7 @@ a subset of features supported by your application for that version. The struct scheme can be found in [03-connection/types](https://github.com/cosmos/ibc-go/blob/main/modules/core/03-connection/types/version.go#L16). Since the version type is a string, applications have the ability to do simple version verification -via string matching or they can use the already impelemented versioning system and pass the proto +via string matching or they can use the already implemented versioning system and pass the proto encoded version into each handhshake call as necessary. ICS20 currently implements basic string matching with a single supported version. diff --git a/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/03-bindports.md b/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/03-bindports.md index a57ec4c6000..d3b4cc6169c 100644 --- a/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/03-bindports.md +++ b/docs/versioned_docs/version-v5.3.x/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ Currently, ports must be bound on app initialization. In order to bind modules t if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/versioned_docs/version-v5.3.x/01-ibc/04-middleware/01-develop.md b/docs/versioned_docs/version-v5.3.x/01-ibc/04-middleware/01-develop.md index 27304558b5f..9eb5b42ee09 100644 --- a/docs/versioned_docs/version-v5.3.x/01-ibc/04-middleware/01-develop.md +++ b/docs/versioned_docs/version-v5.3.x/01-ibc/04-middleware/01-develop.md @@ -46,7 +46,7 @@ IBC middleware will wrap over an underlying IBC application and sits between cor ```go // Middleware implements the ICS26 Module interface type Middleware interface { - porttypes.IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + porttypes.IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ics4Wrapper: ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` diff --git a/docs/versioned_docs/version-v5.3.x/01-ibc/09-roadmap.md b/docs/versioned_docs/version-v5.3.x/01-ibc/09-roadmap.md index cf7f7e6fafe..7204f09dc3c 100644 --- a/docs/versioned_docs/version-v5.3.x/01-ibc/09-roadmap.md +++ b/docs/versioned_docs/version-v5.3.x/01-ibc/09-roadmap.md @@ -33,7 +33,7 @@ At a high level we will focus on: - Finishing and releasing the upgrade to Cosmos SDK v0.46. - Writing the [light client implementation guide](https://github.com/cosmos/ibc-go/issues/59). - Working on [core backlog issues](https://github.com/cosmos/ibc-go/milestone/28). -- Depending on the timeline of the Cosmos SDK, implementing and testing the changes needed to support the [transtion to SMT storage](https://github.com/cosmos/ibc-go/milestone/21). +- Depending on the timeline of the Cosmos SDK, implementing and testing the changes needed to support the [transition to SMT storage](https://github.com/cosmos/ibc-go/milestone/21). We have also received a lot of feedback to improve Interchain Accounts and we might also work on a few things, but will depend on priorities and availability. diff --git a/docs/versioned_docs/version-v5.3.x/03-middleware/01-ics29-fee/03-msgs.md b/docs/versioned_docs/version-v5.3.x/03-middleware/01-ics29-fee/03-msgs.md index b9b69adfac3..40a2622ad2f 100644 --- a/docs/versioned_docs/version-v5.3.x/03-middleware/01-ics29-fee/03-msgs.md +++ b/docs/versioned_docs/version-v5.3.x/03-middleware/01-ics29-fee/03-msgs.md @@ -26,7 +26,7 @@ The fee middleware module exposes two different ways to pay fees for relaying IB Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/versioned_docs/version-v6.2.x/01-ibc/02-integration.md b/docs/versioned_docs/version-v6.2.x/01-ibc/02-integration.md index 60bedf7e216..f1d849ee7d6 100644 --- a/docs/versioned_docs/version-v6.2.x/01-ibc/02-integration.md +++ b/docs/versioned_docs/version-v6.2.x/01-ibc/02-integration.md @@ -17,7 +17,7 @@ send fungible token transfers to other chains. ## Integrating the IBC module -Integrating the IBC module to your SDK-based application is straighforward. The general changes can be summarized in the following steps: +Integrating the IBC module to your SDK-based application is straightforward. The general changes can be summarized in the following steps: - Add required modules to the `module.BasicManager` - Define additional `Keeper` fields for the new modules on the `App` type @@ -178,7 +178,7 @@ One addition from IBC is the concept of `HistoricalEntries` which are stored on Each entry contains the historical information for the `Header` and `ValidatorSet` of this chain which is stored at each height during the `BeginBlock` call. The historical info is required to introspect the past historical info at any given height in order to verify the light client `ConsensusState` during the -connection handhake. +connection handshake. The IBC module also has [`BeginBlock`](https://github.com/cosmos/ibc-go/blob/main/modules/core/02-client/abci.go) logic as well. This is optional as it is only required if your application uses the localhost client to connect two different modules from the same chain. diff --git a/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/02-ibcmodule.md b/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/02-ibcmodule.md index 6b25e53ab20..64f992a8752 100644 --- a/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/02-ibcmodule.md +++ b/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/02-ibcmodule.md @@ -207,7 +207,7 @@ a subset of features supported by your application for that version. The struct scheme can be found in [03-connection/types](https://github.com/cosmos/ibc-go/blob/main/modules/core/03-connection/types/version.go#L16). Since the version type is a string, applications have the ability to do simple version verification -via string matching or they can use the already impelemented versioning system and pass the proto +via string matching or they can use the already implemented versioning system and pass the proto encoded version into each handhshake call as necessary. ICS20 currently implements basic string matching with a single supported version. diff --git a/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/03-bindports.md b/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/03-bindports.md index a57ec4c6000..d3b4cc6169c 100644 --- a/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/03-bindports.md +++ b/docs/versioned_docs/version-v6.2.x/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ Currently, ports must be bound on app initialization. In order to bind modules t if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/versioned_docs/version-v6.2.x/01-ibc/04-middleware/01-develop.md b/docs/versioned_docs/version-v6.2.x/01-ibc/04-middleware/01-develop.md index cf376ee1ba8..eb953b8f962 100644 --- a/docs/versioned_docs/version-v6.2.x/01-ibc/04-middleware/01-develop.md +++ b/docs/versioned_docs/version-v6.2.x/01-ibc/04-middleware/01-develop.md @@ -46,7 +46,7 @@ IBC middleware will wrap over an underlying IBC application and sits between cor ```go // Middleware implements the ICS26 Module interface type Middleware interface { - porttypes.IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + porttypes.IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ics4Wrapper: ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` diff --git a/docs/versioned_docs/version-v6.2.x/01-ibc/09-roadmap.md b/docs/versioned_docs/version-v6.2.x/01-ibc/09-roadmap.md index cf7f7e6fafe..7204f09dc3c 100644 --- a/docs/versioned_docs/version-v6.2.x/01-ibc/09-roadmap.md +++ b/docs/versioned_docs/version-v6.2.x/01-ibc/09-roadmap.md @@ -33,7 +33,7 @@ At a high level we will focus on: - Finishing and releasing the upgrade to Cosmos SDK v0.46. - Writing the [light client implementation guide](https://github.com/cosmos/ibc-go/issues/59). - Working on [core backlog issues](https://github.com/cosmos/ibc-go/milestone/28). -- Depending on the timeline of the Cosmos SDK, implementing and testing the changes needed to support the [transtion to SMT storage](https://github.com/cosmos/ibc-go/milestone/21). +- Depending on the timeline of the Cosmos SDK, implementing and testing the changes needed to support the [transition to SMT storage](https://github.com/cosmos/ibc-go/milestone/21). We have also received a lot of feedback to improve Interchain Accounts and we might also work on a few things, but will depend on priorities and availability. diff --git a/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/02-development.md b/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/02-development.md index 06b292d7954..e7bca4114ba 100644 --- a/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/02-development.md +++ b/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/02-development.md @@ -25,7 +25,7 @@ It may be desirable to allow smart contracts to control an interchain account. To facilitate such an action, the controller submodule may be provided an underlying application which redirects to smart contract callers. An improved design has been suggested in [ADR 008](https://github.com/cosmos/ibc-go/pull/1976) which performs this action via middleware. -Implementors of this use case are recommended to follow the ADR 008 approach. +Implementers of this use case are recommended to follow the ADR 008 approach. The underlying application may continue to be used as a short term solution for ADR 008 and the [legacy API](03-auth-modules.md#registerinterchainaccount) should continue to be utilized in such situations. ## Packet callbacks diff --git a/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/05-messages.md b/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/05-messages.md index e9d6c517752..e41ff0db70a 100644 --- a/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/05-messages.md +++ b/docs/versioned_docs/version-v6.2.x/02-apps/02-interchain-accounts/05-messages.md @@ -10,7 +10,7 @@ slug: /apps/interchain-accounts/messages ## `MsgRegisterInterchainAccount` -An Interchain Accounts channel handshake can be initated using `MsgRegisterInterchainAccount`: +An Interchain Accounts channel handshake can be initiated using `MsgRegisterInterchainAccount`: ```go type MsgRegisterInterchainAccount struct { diff --git a/docs/versioned_docs/version-v6.2.x/03-middleware/01-ics29-fee/03-msgs.md b/docs/versioned_docs/version-v6.2.x/03-middleware/01-ics29-fee/03-msgs.md index b43cd8443b0..ecdc914a46c 100644 --- a/docs/versioned_docs/version-v6.2.x/03-middleware/01-ics29-fee/03-msgs.md +++ b/docs/versioned_docs/version-v6.2.x/03-middleware/01-ics29-fee/03-msgs.md @@ -25,7 +25,7 @@ The fee middleware module exposes two different ways to pay fees for relaying IB Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/versioned_docs/version-v6.2.x/04-migrations/06-v4-to-v5.md b/docs/versioned_docs/version-v6.2.x/04-migrations/06-v4-to-v5.md index 5cff00cf833..885df27b95f 100644 --- a/docs/versioned_docs/version-v6.2.x/04-migrations/06-v4-to-v5.md +++ b/docs/versioned_docs/version-v6.2.x/04-migrations/06-v4-to-v5.md @@ -286,7 +286,7 @@ default: // for SDK 0.45 and below } ``` -See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corrresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). +See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). ### ICS29 - Fee Middleware diff --git a/docs/versioned_docs/version-v7.3.x/01-ibc/02-integration.md b/docs/versioned_docs/version-v7.3.x/01-ibc/02-integration.md index a067f357ef3..1141c817ae1 100644 --- a/docs/versioned_docs/version-v7.3.x/01-ibc/02-integration.md +++ b/docs/versioned_docs/version-v7.3.x/01-ibc/02-integration.md @@ -18,7 +18,7 @@ send fungible token transfers to other chains. ## Integrating the IBC module -Integrating the IBC module to your SDK-based application is straighforward. The general changes can be summarized in the following steps: +Integrating the IBC module to your SDK-based application is straightforward. The general changes can be summarized in the following steps: - Add required modules to the `module.BasicManager` - Define additional `Keeper` fields for the new modules on the `App` type @@ -199,7 +199,7 @@ One addition from IBC is the concept of `HistoricalEntries` which are stored on Each entry contains the historical information for the `Header` and `ValidatorSet` of this chain which is stored at each height during the `BeginBlock` call. The historical info is required to introspect the past historical info at any given height in order to verify the light client `ConsensusState` during the -connection handhake. +connection handshake. ```go // app.go diff --git a/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/02-ibcmodule.md b/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/02-ibcmodule.md index ec080e71b7a..e654a6a03ad 100644 --- a/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/02-ibcmodule.md +++ b/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/02-ibcmodule.md @@ -208,7 +208,7 @@ a subset of features supported by your application for that version. The struct scheme can be found in [03-connection/types](https://github.com/cosmos/ibc-go/blob/main/modules/core/03-connection/types/version.go#L16). Since the version type is a string, applications have the ability to do simple version verification -via string matching or they can use the already impelemented versioning system and pass the proto +via string matching or they can use the already implemented versioning system and pass the proto encoded version into each handhshake call as necessary. ICS20 currently implements basic string matching with a single supported version. diff --git a/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/03-bindports.md b/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/03-bindports.md index a57ec4c6000..d3b4cc6169c 100644 --- a/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/03-bindports.md +++ b/docs/versioned_docs/version-v7.3.x/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ Currently, ports must be bound on app initialization. In order to bind modules t if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/versioned_docs/version-v7.3.x/01-ibc/04-middleware/01-develop.md b/docs/versioned_docs/version-v7.3.x/01-ibc/04-middleware/01-develop.md index 4403e816f82..59fe89f72fa 100644 --- a/docs/versioned_docs/version-v7.3.x/01-ibc/04-middleware/01-develop.md +++ b/docs/versioned_docs/version-v7.3.x/01-ibc/04-middleware/01-develop.md @@ -46,7 +46,7 @@ IBC middleware will wrap over an underlying IBC application and sits between cor ```go // Middleware implements the ICS26 Module interface type Middleware interface { - porttypes.IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + porttypes.IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ics4Wrapper: ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` diff --git a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/02-development.md b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/02-development.md index c0893883017..58b9e4e67aa 100644 --- a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/02-development.md +++ b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/02-development.md @@ -25,7 +25,7 @@ It may be desirable to allow smart contracts to control an interchain account. To facilitate such an action, the controller submodule may be provided an underlying application which redirects to smart contract callers. An improved design has been suggested in [ADR 008](https://github.com/cosmos/ibc-go/pull/1976) which performs this action via middleware. -Implementors of this use case are recommended to follow the ADR 008 approach. +Implementers of this use case are recommended to follow the ADR 008 approach. The underlying application may continue to be used as a short term solution for ADR 008 and the [legacy API](03-auth-modules.md#registerinterchainaccount) should continue to be utilized in such situations. ## Packet callbacks diff --git a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/05-messages.md b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/05-messages.md index 0c29e7364c5..c6c546e82cf 100644 --- a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/05-messages.md +++ b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/05-messages.md @@ -10,7 +10,7 @@ slug: /apps/interchain-accounts/messages ## `MsgRegisterInterchainAccount` -An Interchain Accounts channel handshake can be initated using `MsgRegisterInterchainAccount`: +An Interchain Accounts channel handshake can be initiated using `MsgRegisterInterchainAccount`: ```go type MsgRegisterInterchainAccount struct { diff --git a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/08-client.md b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/08-client.md index c7c50d09d82..023495a2aec 100644 --- a/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/08-client.md +++ b/docs/versioned_docs/version-v7.3.x/02-apps/02-interchain-accounts/08-client.md @@ -87,7 +87,7 @@ simd tx interchain-accounts host --help ##### `generate-packet-data` -The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be uesd to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. +The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be used to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. ```shell simd tx interchain-accounts host generate-packet-data [message] diff --git a/docs/versioned_docs/version-v7.3.x/03-light-clients/01-developer-guide/09-setup.md b/docs/versioned_docs/version-v7.3.x/03-light-clients/01-developer-guide/09-setup.md index 9b5c33abccd..c4a10b8f937 100644 --- a/docs/versioned_docs/version-v7.3.x/03-light-clients/01-developer-guide/09-setup.md +++ b/docs/versioned_docs/version-v7.3.x/03-light-clients/01-developer-guide/09-setup.md @@ -53,7 +53,7 @@ func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage { return nil } -// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light cilent. +// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light client. func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error { return nil } diff --git a/docs/versioned_docs/version-v7.3.x/04-middleware/01-ics29-fee/03-msgs.md b/docs/versioned_docs/version-v7.3.x/04-middleware/01-ics29-fee/03-msgs.md index 10b9ed94491..c8e98f8192a 100644 --- a/docs/versioned_docs/version-v7.3.x/04-middleware/01-ics29-fee/03-msgs.md +++ b/docs/versioned_docs/version-v7.3.x/04-middleware/01-ics29-fee/03-msgs.md @@ -26,7 +26,7 @@ The fee middleware module exposes two different ways to pay fees for relaying IB Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/versioned_docs/version-v7.3.x/05-migrations/06-v4-to-v5.md b/docs/versioned_docs/version-v7.3.x/05-migrations/06-v4-to-v5.md index dfeefc2802b..0acb188cf2f 100644 --- a/docs/versioned_docs/version-v7.3.x/05-migrations/06-v4-to-v5.md +++ b/docs/versioned_docs/version-v7.3.x/05-migrations/06-v4-to-v5.md @@ -286,7 +286,7 @@ default: // for SDK 0.45 and below } ``` -See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corrresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). +See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). ### ICS29 - Fee Middleware diff --git a/docs/versioned_docs/version-v8.0.x/01-ibc/03-apps/03-bindports.md b/docs/versioned_docs/version-v8.0.x/01-ibc/03-apps/03-bindports.md index 4bd85d29bc5..6a3cc27a924 100644 --- a/docs/versioned_docs/version-v8.0.x/01-ibc/03-apps/03-bindports.md +++ b/docs/versioned_docs/version-v8.0.x/01-ibc/03-apps/03-bindports.md @@ -70,7 +70,7 @@ func (gs GenesisState) Validate() error { if err := host.PortIdentifierValidator(gs.PortId); err != nil { return err } - //addtional validations + //additional validations return gs.Params.Validate() } diff --git a/docs/versioned_docs/version-v8.0.x/01-ibc/04-middleware/02-develop.md b/docs/versioned_docs/version-v8.0.x/01-ibc/04-middleware/02-develop.md index aff2a14b076..aab84102357 100644 --- a/docs/versioned_docs/version-v8.0.x/01-ibc/04-middleware/02-develop.md +++ b/docs/versioned_docs/version-v8.0.x/01-ibc/04-middleware/02-develop.md @@ -15,7 +15,7 @@ The interfaces a middleware must implement are found [here](https://github.com/c ```go // Middleware implements the ICS26 Module interface type Middleware interface { - IBCModule // middleware has acccess to an underlying application which may be wrapped by more middleware + IBCModule // middleware has access to an underlying application which may be wrapped by more middleware ICS4Wrapper // middleware has access to ICS4Wrapper which may be core IBC Channel Handler or a higher-level middleware that wraps this middleware. } ``` @@ -386,7 +386,7 @@ See [here](https://github.com/cosmos/ibc-go/blob/v7.0.0/modules/apps/29-fee/ibc_ Middleware must also wrap ICS-04 so that any communication from the application to the `channelKeeper` goes through the middleware first. Similar to the packet callbacks, the middleware may modify outgoing acknowledgements and packets in any way it wishes. -To ensure optimal generalisability, the `ICS4Wrapper` abstraction serves to abstract away whether a middleware is the topmost middleware (and thus directly caling into the ICS-04 `channelKeeper`) or itself being wrapped by another middleware. +To ensure optimal generalisability, the `ICS4Wrapper` abstraction serves to abstract away whether a middleware is the topmost middleware (and thus directly calling into the ICS-04 `channelKeeper`) or itself being wrapped by another middleware. Remember that middleware can be stateful or stateless. When defining the stateful middleware's keeper, the `ics4Wrapper` field is included. Then the appropriate keeper can be passed when instantiating the middleware's keeper in `app.go` diff --git a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/02-development.md b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/02-development.md index 720527b4693..c42696cc514 100644 --- a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/02-development.md +++ b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/02-development.md @@ -25,7 +25,7 @@ It may be desirable to allow smart contracts to control an interchain account. To facilitate such an action, the controller submodule may be provided an underlying application which redirects to smart contract callers. An improved design has been suggested in [ADR 008](https://github.com/cosmos/ibc-go/pull/1976) which performs this action via middleware. -Implementors of this use case are recommended to follow the ADR 008 approach. +Implementers of this use case are recommended to follow the ADR 008 approach. The underlying application may continue to be used as a short term solution for ADR 008 and the [legacy API](03-auth-modules.md#registerinterchainaccount) should continue to be utilized in such situations. ## Packet callbacks diff --git a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/05-messages.md b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/05-messages.md index 119c740e03e..e94dc7c41fc 100644 --- a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/05-messages.md +++ b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/05-messages.md @@ -10,7 +10,7 @@ slug: /apps/interchain-accounts/messages ## `MsgRegisterInterchainAccount` -An Interchain Accounts channel handshake can be initated using `MsgRegisterInterchainAccount`: +An Interchain Accounts channel handshake can be initiated using `MsgRegisterInterchainAccount`: ```go type MsgRegisterInterchainAccount struct { diff --git a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/08-client.md b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/08-client.md index c7c50d09d82..023495a2aec 100644 --- a/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/08-client.md +++ b/docs/versioned_docs/version-v8.0.x/02-apps/02-interchain-accounts/08-client.md @@ -87,7 +87,7 @@ simd tx interchain-accounts host --help ##### `generate-packet-data` -The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be uesd to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. +The `generate-packet-data` command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's [`send-tx` command](#send-tx). The `--encoding` flag can be used to specify the encoding format (value must be either `proto3` or `proto3json`); if not specified, the default will be `proto3`. The `--memo` flag can be used to include a memo string in the interchain accounts packet data. ```shell simd tx interchain-accounts host generate-packet-data [message] diff --git a/docs/versioned_docs/version-v8.0.x/03-light-clients/01-developer-guide/09-setup.md b/docs/versioned_docs/version-v8.0.x/03-light-clients/01-developer-guide/09-setup.md index f3bba760ec2..904a53262d1 100644 --- a/docs/versioned_docs/version-v8.0.x/03-light-clients/01-developer-guide/09-setup.md +++ b/docs/versioned_docs/version-v8.0.x/03-light-clients/01-developer-guide/09-setup.md @@ -53,7 +53,7 @@ func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage { return nil } -// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light cilent. +// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light client. func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error { return nil } diff --git a/docs/versioned_docs/version-v8.0.x/04-middleware/01-ics29-fee/03-msgs.md b/docs/versioned_docs/version-v8.0.x/04-middleware/01-ics29-fee/03-msgs.md index 4496df29f98..d1b26238a17 100644 --- a/docs/versioned_docs/version-v8.0.x/04-middleware/01-ics29-fee/03-msgs.md +++ b/docs/versioned_docs/version-v8.0.x/04-middleware/01-ics29-fee/03-msgs.md @@ -25,7 +25,7 @@ type MsgPayPacketFee struct{ Fee Fee // the source port unique identifier SourcePortId string - // the source channel unique identifer + // the source channel unique identifier SourceChannelId string // account address to refund fee if necessary Signer string diff --git a/docs/versioned_docs/version-v8.0.x/05-migrations/06-v4-to-v5.md b/docs/versioned_docs/version-v8.0.x/05-migrations/06-v4-to-v5.md index d5055d5006a..c5e8c84db1c 100644 --- a/docs/versioned_docs/version-v8.0.x/05-migrations/06-v4-to-v5.md +++ b/docs/versioned_docs/version-v8.0.x/05-migrations/06-v4-to-v5.md @@ -286,7 +286,7 @@ default: // for SDK 0.45 and below } ``` -See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corrresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). +See [ADR-03](/architecture/adr-003-ics27-acknowledgement#next-major-version-format) for more information or the [corresponding documentation about authentication modules](../02-apps/02-interchain-accounts/03-auth-modules.md#onacknowledgementpacket). ### ICS29 - Fee Middleware diff --git a/e2e/README.md b/e2e/README.md index 332bbb7b977..b39f4728309 100644 --- a/e2e/README.md +++ b/e2e/README.md @@ -60,7 +60,7 @@ options specified in your config file. > Note: when running tests locally, **no images are pushed** to the `ghcr.io/cosmos/ibc-go-simd` registry. The images which are used only exist on your machine. -These environment variables allow us to run tests with arbitrary verions (from branches or released) of simd +These environment variables allow us to run tests with arbitrary versions (from branches or released) of simd and the go relayer. Every time changes are pushed to a branch or to `main`, a new `simd` image is built and pushed [here](https://github.com/cosmos/ibc-go/pkgs/container/ibc-go-simd). diff --git a/e2e/tests/interchain_accounts/groups_test.go b/e2e/tests/interchain_accounts/groups_test.go index cb35af1a20f..6fe99fe533b 100644 --- a/e2e/tests/interchain_accounts/groups_test.go +++ b/e2e/tests/interchain_accounts/groups_test.go @@ -35,7 +35,7 @@ const ( // exceeded for a proposal to succeed. DefaultGroupThreshold = "1" - // DefaultMetadata defines a resusable metadata string for testing purposes + // DefaultMetadata defines a reusable metadata string for testing purposes DefaultMetadata = "custom metadata" // DefaultMinExecutionPeriod is the minimum duration after the proposal submission diff --git a/modules/apps/27-interchain-accounts/controller/keeper/account.go b/modules/apps/27-interchain-accounts/controller/keeper/account.go index bd0b04513c4..42d4c879d8f 100644 --- a/modules/apps/27-interchain-accounts/controller/keeper/account.go +++ b/modules/apps/27-interchain-accounts/controller/keeper/account.go @@ -85,7 +85,7 @@ func (k Keeper) registerInterchainAccount(ctx sdk.Context, connectionID, portID, firstMsgResponse := res.MsgResponses[0] channelOpenInitResponse, ok := firstMsgResponse.GetCachedValue().(*channeltypes.MsgChannelOpenInitResponse) if !ok { - return "", errorsmod.Wrapf(ibcerrors.ErrInvalidType, "failed to covert %T message response to %T", firstMsgResponse.GetCachedValue(), &channeltypes.MsgChannelOpenInitResponse{}) + return "", errorsmod.Wrapf(ibcerrors.ErrInvalidType, "failed to convert %T message response to %T", firstMsgResponse.GetCachedValue(), &channeltypes.MsgChannelOpenInitResponse{}) } return channelOpenInitResponse.ChannelId, nil diff --git a/modules/apps/27-interchain-accounts/controller/keeper/handshake.go b/modules/apps/27-interchain-accounts/controller/keeper/handshake.go index 0ce3802b48e..80ff3603734 100644 --- a/modules/apps/27-interchain-accounts/controller/keeper/handshake.go +++ b/modules/apps/27-interchain-accounts/controller/keeper/handshake.go @@ -17,7 +17,7 @@ import ( // The channel order must be ORDERED, the counterparty port identifier // must be the host chain representation as defined in the types package, // the channel version must be equal to the version in the types package, -// there must not be an active channel for the specfied port identifier, +// there must not be an active channel for the specified port identifier, // and the interchain accounts module must be able to claim the channel // capability. func (k Keeper) OnChanOpenInit( diff --git a/modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go b/modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go index cb63db4ecd4..4aec10eb05a 100644 --- a/modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go +++ b/modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go @@ -95,7 +95,7 @@ func (suite *MigrationsTestSuite) TestMigrateICS27ChannelCapability() { suite.CreateMockCapabilities() // create and claim a new capability with ibc/mock for "channel-1" - // note: suite.SetupPath() now claims the chanel capability using icacontroller for "channel-0" + // note: suite.SetupPath() now claims the channel capability using icacontroller for "channel-0" capName := host.ChannelCapabilityPath(suite.path.EndpointA.ChannelConfig.PortID, channeltypes.FormatChannelIdentifier(1)) capability, err := suite.chainA.GetSimApp().ScopedIBCKeeper.NewCapability(suite.chainA.GetContext(), capName) diff --git a/modules/apps/27-interchain-accounts/module.go b/modules/apps/27-interchain-accounts/module.go index 436c61a1a4f..62e2c3e0333 100644 --- a/modules/apps/27-interchain-accounts/module.go +++ b/modules/apps/27-interchain-accounts/module.go @@ -73,7 +73,7 @@ func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage { return cdc.MustMarshalJSON(genesistypes.DefaultGenesis()) } -// ValidateGenesis performs genesis state validation for the IBC interchain acounts module +// ValidateGenesis performs genesis state validation for the IBC interchain accounts module func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error { var gs genesistypes.GenesisState if err := cdc.UnmarshalJSON(bz, &gs); err != nil { diff --git a/modules/apps/27-interchain-accounts/types/packet_test.go b/modules/apps/27-interchain-accounts/types/packet_test.go index c8bbec6ced8..b8dd1043743 100644 --- a/modules/apps/27-interchain-accounts/types/packet_test.go +++ b/modules/apps/27-interchain-accounts/types/packet_test.go @@ -149,7 +149,7 @@ func (suite *TypesTestSuite) TestPacketDataProvider() { }, }, { - "success: src_callback has string valu", + "success: src_callback has string value", types.InterchainAccountPacketData{ Type: types.EXECUTE_TX, Data: []byte("data"), diff --git a/modules/apps/29-fee/ibc_middleware.go b/modules/apps/29-fee/ibc_middleware.go index fa97ae7423f..385a29ef6f2 100644 --- a/modules/apps/29-fee/ibc_middleware.go +++ b/modules/apps/29-fee/ibc_middleware.go @@ -223,7 +223,7 @@ func (im IBCMiddleware) OnRecvPacket( ack := im.app.OnRecvPacket(ctx, packet, relayer) - // in case of async aknowledgement (ack == nil) store the relayer address for use later during async WriteAcknowledgement + // in case of async acknowledgement (ack == nil) store the relayer address for use later during async WriteAcknowledgement if ack == nil { im.keeper.SetRelayerAddressForAsyncAck(ctx, channeltypes.NewPacketID(packet.GetDestPort(), packet.GetDestChannel(), packet.GetSequence()), relayer.String()) return nil diff --git a/modules/apps/29-fee/types/keys.go b/modules/apps/29-fee/types/keys.go index 6a967d4cd7b..9edd77ae14e 100644 --- a/modules/apps/29-fee/types/keys.go +++ b/modules/apps/29-fee/types/keys.go @@ -79,7 +79,7 @@ func KeyPayee(relayerAddr, channelID string) []byte { return []byte(fmt.Sprintf("%s/%s/%s", PayeeKeyPrefix, relayerAddr, channelID)) } -// ParseKeyPayeeAddress returns the registered relayer addresss and channelID used to the store the fee payee address +// ParseKeyPayeeAddress returns the registered relayer address and channelID used to the store the fee payee address func ParseKeyPayeeAddress(key string) (relayerAddr, channelID string, err error) { keySplit := strings.Split(key, "/") if len(keySplit) != 3 { diff --git a/modules/apps/callbacks/testing/simapp/params/proto.go b/modules/apps/callbacks/testing/simapp/params/proto.go index 4270c2b0dbf..73702a15abf 100644 --- a/modules/apps/callbacks/testing/simapp/params/proto.go +++ b/modules/apps/callbacks/testing/simapp/params/proto.go @@ -11,7 +11,7 @@ import ( // MakeTestEncodingConfig creates an EncodingConfig for a non-amino based test configuration. // This function should be used only internally (in the SDK). -// App user should'nt create new codecs - use the app.AppCodec instead. +// App user shouldn't create new codecs - use the app.AppCodec instead. // [DEPRECATED] func MakeTestEncodingConfig() EncodingConfig { cdc := codec.NewLegacyAmino() diff --git a/modules/apps/transfer/client/cli/query.go b/modules/apps/transfer/client/cli/query.go index 7aebe004b3b..82d05cda2f7 100644 --- a/modules/apps/transfer/client/cli/query.go +++ b/modules/apps/transfer/client/cli/query.go @@ -45,7 +45,7 @@ func GetCmdQueryDenomTrace() *cobra.Command { } // GetCmdQueryDenomTraces defines the command to query all the denomination trace infos -// that this chain mantains. +// that this chain maintains. func GetCmdQueryDenomTraces() *cobra.Command { cmd := &cobra.Command{ Use: "denom-traces", diff --git a/modules/apps/transfer/keeper/keeper.go b/modules/apps/transfer/keeper/keeper.go index 78a0be057dc..61b528ef1c8 100644 --- a/modules/apps/transfer/keeper/keeper.go +++ b/modules/apps/transfer/keeper/keeper.go @@ -139,7 +139,7 @@ func (k Keeper) SetParams(ctx sdk.Context, params types.Params) { store.Set([]byte(types.ParamsKey), bz) } -// GetDenomTrace retreives the full identifiers trace and base denomination from the store. +// GetDenomTrace retrieves the full identifiers trace and base denomination from the store. func (k Keeper) GetDenomTrace(ctx sdk.Context, denomTraceHash cmtbytes.HexBytes) (types.DenomTrace, bool) { store := prefix.NewStore(ctx.KVStore(k.storeKey), types.DenomTraceKey) bz := store.Get(denomTraceHash) diff --git a/modules/apps/transfer/keeper/relay.go b/modules/apps/transfer/keeper/relay.go index d98d777c697..f598faec012 100644 --- a/modules/apps/transfer/keeper/relay.go +++ b/modules/apps/transfer/keeper/relay.go @@ -124,7 +124,7 @@ func (k Keeper) sendTransfer( ctx, types.ModuleName, sdk.NewCoins(token), ); err != nil { // NOTE: should not happen as the module account was - // retrieved on the step above and it has enough balace + // retrieved on the step above and it has enough balance // to burn. panic(fmt.Errorf("cannot burn coins after a successful send to a module account: %v", err)) } diff --git a/modules/apps/transfer/keeper/relay_model/account.tla b/modules/apps/transfer/keeper/relay_model/account.tla index 84d743f6da6..00704b03a1d 100644 --- a/modules/apps/transfer/keeper/relay_model/account.tla +++ b/modules/apps/transfer/keeper/relay_model/account.tla @@ -18,7 +18,7 @@ Accounts == { NullAccount } \* Make an escrow account for the given port and channel MakeEscrowAccount(port, channel) == NullAccount -\* Make an account from the accound id +\* Make an account from the account id MakeAccount(accountId) == NullAccount \* Type constraints for accounts diff --git a/modules/apps/transfer/keeper/relay_model/relay.tla b/modules/apps/transfer/keeper/relay_model/relay.tla index 029df3d7c7b..7a617227876 100644 --- a/modules/apps/transfer/keeper/relay_model/relay.tla +++ b/modules/apps/transfer/keeper/relay_model/relay.tla @@ -1,6 +1,6 @@ -------------------------- MODULE relay ---------------------------- (** - * A primitive model for account arithmetics and token movement + * A primitive model for account arithmetic and token movement * of the Cosmos SDK ICS20 Token Transfer * We completely abstract away many details, * and want to focus on a minimal spec useful for testing @@ -210,7 +210,7 @@ OnTimeoutPacketNext(packet) == /\ error' = FALSE /\ IF ~IsSource(packet) THEN - \* transfer from the escrow acount to the sender account + \* transfer from the escrow account to the sender account \* LET denomsuffix == SubSeq(denom, 3, Len(denom)) IN LET escrow == GetSourceEscrowAccount(packet) IN bank' = [bankwithsender diff --git a/modules/apps/transfer/keeper/relay_test.go b/modules/apps/transfer/keeper/relay_test.go index 797fd60f690..a9c914d6cd9 100644 --- a/modules/apps/transfer/keeper/relay_test.go +++ b/modules/apps/transfer/keeper/relay_test.go @@ -16,8 +16,8 @@ import ( ibctesting "github.com/cosmos/ibc-go/v8/testing" ) -// test sending from chainA to chainB using both coin that orignate on -// chainA and coin that orignate on chainB +// test sending from chainA to chainB using both coin that originate on +// chainA and coin that originate on chainB func (suite *KeeperTestSuite) TestSendTransfer() { var ( coin sdk.Coin @@ -181,16 +181,16 @@ func (suite *KeeperTestSuite) TestSendTransferSetsTotalEscrowAmountForSourceIBCT Set up: - Two transfer channels between chain A and chain B (channel-0 and channel-1). - Tokens of native denom "stake" on chain A transferred to chain B over channel-0 - and vouchers minted with denom trace "tranfer/channel-0/stake". + and vouchers minted with denom trace "transfer/channel-0/stake". Execute: - - Transfer vouchers of denom trace "tranfer/channel-0/stake" from chain B to chain A + - Transfer vouchers of denom trace "transfer/channel-0/stake" from chain B to chain A over channel-1. Assert: - The vouchers are not of a native denom (because they are of an IBC denom), but chain B is the source, then the value for total escrow amount should still be stored for the IBC - denom that corresponds to the trace "tranfer/channel-0/stake". + denom that corresponds to the trace "transfer/channel-0/stake". */ // set up @@ -241,7 +241,7 @@ func (suite *KeeperTestSuite) TestSendTransferSetsTotalEscrowAmountForSourceIBCT suite.Require().Equal(sdkmath.NewInt(100), totalEscrow.Amount) } -// test receiving coin on chainB with coin that orignate on chainA and +// test receiving coin on chainB with coin that originate on chainA and // coin that originated on chainB (source). The bulk of the testing occurs // in the test case for loop since setup is intensive for all cases. The // malleate function allows for testing invalid cases. @@ -453,7 +453,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacketSetsTotalEscrowAmountForSourceIBCT Assert: - The vouchers are not of a native denom (because they are of an IBC denom), but chain B is the source, then the value for total escrow amount should still be updated for the IBC - denom that corresponds to the trace "tranfer/channel-0/stake" when the vouchers are + denom that corresponds to the trace "transfer/channel-0/stake" when the vouchers are received back on chain B. */ @@ -515,7 +515,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacketSetsTotalEscrowAmountForSourceIBCT err := suite.chainB.GetSimApp().TransferKeeper.OnRecvPacket(suite.chainB.GetContext(), packet, data) suite.Require().NoError(err) - // check total amount in escrow of sent token on reveiving chain + // check total amount in escrow of sent token on receiving chain totalEscrowChainB = suite.chainB.GetSimApp().TransferKeeper.GetTotalEscrowForDenom(suite.chainB.GetContext(), coin.GetDenom()) suite.Require().Equal(sdkmath.ZeroInt(), totalEscrowChainB.Amount) } @@ -644,13 +644,13 @@ func (suite *KeeperTestSuite) TestOnAcknowledgementPacketSetsTotalEscrowAmountFo account for port ID transfer and channel ID channel-1. Execute: - - Acknowledge vouchers of denom trace "tranfer/channel-0/stake" sent from chain B + - Acknowledge vouchers of denom trace "transfer/channel-0/stake" sent from chain B to chain B over channel-1. Assert: - The vouchers are not of a native denom (because they are of an IBC denom), but chain B is the source, then the value for total escrow amount should still be updated for the IBC - denom that corresponds to the trace "tranfer/channel-0/stake" when processing the failed + denom that corresponds to the trace "transfer/channel-0/stake" when processing the failed acknowledgement. */ @@ -841,13 +841,13 @@ func (suite *KeeperTestSuite) TestOnTimeoutPacketSetsTotalEscrowAmountForSourceI account for port ID transfer and channel ID channel-1. Execute: - - Timeout vouchers of denom trace "tranfer/channel-0/stake" sent from chain B + - Timeout vouchers of denom trace "transfer/channel-0/stake" sent from chain B to chain B over channel-1. Assert: - The vouchers are not of a native denom (because they are of an IBC denom), but chain B is the source, then the value for total escrow amount should still be updated for the IBC - denom that corresponds to the trace "tranfer/channel-0/stake" when processing the timeout. + denom that corresponds to the trace "transfer/channel-0/stake" when processing the timeout. */ seq := uint64(1) diff --git a/modules/apps/transfer/types/keys.go b/modules/apps/transfer/types/keys.go index 3ee859e2239..29f9261b698 100644 --- a/modules/apps/transfer/types/keys.go +++ b/modules/apps/transfer/types/keys.go @@ -11,7 +11,7 @@ const ( // ModuleName defines the IBC transfer name ModuleName = "transfer" - // Version defines the current version the IBC tranfer + // Version defines the current version the IBC transfer // module supports Version = "ics20-1" @@ -58,7 +58,7 @@ func GetEscrowAddress(portID, channelID string) sdk.AccAddress { return hash[:20] } -// TotalEscrowForDenomKey returns the store key of under which the total amout of +// TotalEscrowForDenomKey returns the store key of under which the total amount of // source chain tokens in escrow is stored. func TotalEscrowForDenomKey(denom string) []byte { return []byte(fmt.Sprintf("%s/%s", KeyTotalEscrowPrefix, denom)) diff --git a/modules/apps/transfer/types/packet.go b/modules/apps/transfer/types/packet.go index 548c4626797..7a00da24f86 100644 --- a/modules/apps/transfer/types/packet.go +++ b/modules/apps/transfer/types/packet.go @@ -32,7 +32,7 @@ var ( DefaultRelativePacketTimeoutTimestamp = uint64((time.Duration(10) * time.Minute).Nanoseconds()) ) -// NewFungibleTokenPacketData contructs a new FungibleTokenPacketData instance +// NewFungibleTokenPacketData constructs a new FungibleTokenPacketData instance func NewFungibleTokenPacketData( denom string, amount string, sender, receiver string, diff --git a/modules/apps/transfer/types/trace_test.go b/modules/apps/transfer/types/trace_test.go index 828cac53304..49623ed1dec 100644 --- a/modules/apps/transfer/types/trace_test.go +++ b/modules/apps/transfer/types/trace_test.go @@ -170,7 +170,7 @@ func TestValidateIBCDenom(t *testing.T) { {"empty denom", "", true}, {"denom 'ibc'", "ibc", true}, {"denom 'ibc/'", "ibc/", true}, - {"invald hash", "ibc/!@#$!@#", true}, + {"invalid hash", "ibc/!@#$!@#", true}, } for _, tc := range testCases { diff --git a/modules/capability/keeper/keeper.go b/modules/capability/keeper/keeper.go index 8d43fae0b78..bae88188b6e 100644 --- a/modules/capability/keeper/keeper.go +++ b/modules/capability/keeper/keeper.go @@ -108,7 +108,7 @@ func (k *Keeper) IsSealed() bool { } // InitMemStore will assure that the module store is a memory store (it will panic if it's not) -// and willl initialize it. The function is safe to be called multiple times. +// and will initialize it. The function is safe to be called multiple times. // InitMemStore must be called every time the app starts before the keeper is used (so // `BeginBlock` or `InitChain` - whichever is first). We need access to the store so we // can't initialize it in a constructor. @@ -437,7 +437,7 @@ func (sk ScopedKeeper) GetOwners(ctx sdk.Context, name string) (*types.Capabilit // LookupModules returns all the module owners for a given capability // as a string array and the capability itself. // The method returns an error if either the capability or the owners cannot be -// retreived from the memstore. +// retrieved from the memstore. func (sk ScopedKeeper) LookupModules(ctx sdk.Context, name string) ([]string, *types.Capability, error) { if strings.TrimSpace(name) == "" { return nil, nil, errorsmod.Wrap(types.ErrInvalidCapabilityName, "cannot lookup modules with empty capability name") diff --git a/modules/capability/keeper/keeper_test.go b/modules/capability/keeper/keeper_test.go index 12ac910a7c2..7585da92c20 100644 --- a/modules/capability/keeper/keeper_test.go +++ b/modules/capability/keeper/keeper_test.go @@ -44,7 +44,7 @@ func (suite *KeeperTestSuite) TestSeal() { }) caps := make([]*types.Capability, 5) - // Get Latest Index before creating new ones to sychronize indices correctly + // Get Latest Index before creating new ones to synchronize indices correctly prevIndex := suite.keeper.GetLatestIndex(suite.ctx) for i := range caps { diff --git a/modules/core/02-client/client/cli/query.go b/modules/core/02-client/client/cli/query.go index 5fdd3611984..da009523ba4 100644 --- a/modules/core/02-client/client/cli/query.go +++ b/modules/core/02-client/client/cli/query.go @@ -20,7 +20,7 @@ const ( ) // GetCmdQueryClientStates defines the command to query all the light clients -// that this chain mantains. +// that this chain maintains. func GetCmdQueryClientStates() *cobra.Command { cmd := &cobra.Command{ Use: "states", diff --git a/modules/core/02-client/keeper/client_test.go b/modules/core/02-client/keeper/client_test.go index d6aa1465f92..e201f4d7bf7 100644 --- a/modules/core/02-client/keeper/client_test.go +++ b/modules/core/02-client/keeper/client_test.go @@ -189,7 +189,7 @@ func (suite *KeeperTestSuite) TestUpdateClientTendermint() { suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientConsensusState(suite.chainA.GetContext(), clientID, height1, prevConsState) height5 := clienttypes.NewHeight(1, 5) - // store next consensus state to check that trustedHeight does not need to be hightest consensus state before header height + // store next consensus state to check that trustedHeight does not need to be highest consensus state before header height nextConsState := &ibctm.ConsensusState{ Timestamp: suite.past.Add(time.Minute), NextValidatorsHash: suite.chainB.Vals.Hash(), diff --git a/modules/core/02-client/migrations/v7/solomachine.go b/modules/core/02-client/migrations/v7/solomachine.go index 7a8799e6129..c15c16eb1ef 100644 --- a/modules/core/02-client/migrations/v7/solomachine.go +++ b/modules/core/02-client/migrations/v7/solomachine.go @@ -13,7 +13,7 @@ import ( "github.com/cosmos/ibc-go/v8/modules/core/exported" ) -// NOTE: this is a mock implmentation for exported.ClientState. This implementation +// NOTE: this is a mock implementation for exported.ClientState. This implementation // should only be registered on the InterfaceRegistry during cli command genesis migration. // This implementation is only used to successfully unmarshal the previous solo machine // client state and consensus state and migrate them to the new implementations. When the proto diff --git a/modules/core/02-client/types/codec.go b/modules/core/02-client/types/codec.go index 23b99689f91..835b641e7cf 100644 --- a/modules/core/02-client/types/codec.go +++ b/modules/core/02-client/types/codec.go @@ -58,7 +58,7 @@ func RegisterInterfaces(registry codectypes.InterfaceRegistry) { // PackClientState constructs a new Any packed with the given client state value. It returns // an error if the client state can't be casted to a protobuf message or if the concrete -// implemention is not registered to the protobuf codec. +// implementation is not registered to the protobuf codec. func PackClientState(clientState exported.ClientState) (*codectypes.Any, error) { msg, ok := clientState.(proto.Message) if !ok { @@ -90,7 +90,7 @@ func UnpackClientState(any *codectypes.Any) (exported.ClientState, error) { // PackConsensusState constructs a new Any packed with the given consensus state value. It returns // an error if the consensus state can't be casted to a protobuf message or if the concrete -// implemention is not registered to the protobuf codec. +// implementation is not registered to the protobuf codec. func PackConsensusState(consensusState exported.ConsensusState) (*codectypes.Any, error) { msg, ok := consensusState.(proto.Message) if !ok { @@ -132,7 +132,7 @@ func UnpackConsensusState(any *codectypes.Any) (exported.ConsensusState, error) // PackClientMessage constructs a new Any packed with the given value. It returns // an error if the value can't be casted to a protobuf message or if the concrete -// implemention is not registered to the protobuf codec. +// implementation is not registered to the protobuf codec. func PackClientMessage(clientMessage exported.ClientMessage) (*codectypes.Any, error) { msg, ok := clientMessage.(proto.Message) if !ok { diff --git a/modules/core/02-client/types/genesis.go b/modules/core/02-client/types/genesis.go index de0ec27d9ee..44fd613a6f8 100644 --- a/modules/core/02-client/types/genesis.go +++ b/modules/core/02-client/types/genesis.go @@ -107,7 +107,7 @@ func (gs GenesisState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error { // failure. func (gs GenesisState) Validate() error { // keep track of the max sequence to ensure it is less than - // the next sequence used in creating client identifers. + // the next sequence used in creating client identifiers. var maxSequence uint64 if err := gs.Params.Validate(); err != nil { diff --git a/modules/core/02-client/types/height.go b/modules/core/02-client/types/height.go index ca75a1e7ff1..d756f36ae22 100644 --- a/modules/core/02-client/types/height.go +++ b/modules/core/02-client/types/height.go @@ -102,7 +102,7 @@ func (h Height) String() string { } // Decrement will return a new height with the RevisionHeight decremented -// If the RevisionHeight is already at lowest value (1), then false success flag is returend +// If the RevisionHeight is already at lowest value (1), then false success flag is returned func (h Height) Decrement() (decremented exported.Height, success bool) { if h.RevisionHeight == 0 { return Height{}, false diff --git a/modules/core/02-client/types/keys.go b/modules/core/02-client/types/keys.go index 86b132c5195..1ce683827af 100644 --- a/modules/core/02-client/types/keys.go +++ b/modules/core/02-client/types/keys.go @@ -41,7 +41,7 @@ func FormatClientIdentifier(clientType string, sequence uint64) string { // which per the specification only permits ASCII for the {client-type} segment and // 1 to 20 digits for the {N} segment. // `([\w-]+\w)?` allows for a letter or hyphen, with the {client-type} starting with a letter -// and ending with a letter, i.e. `letter+(letter|hypen+letter)?`. +// and ending with a letter, i.e. `letter+(letter|hyphen+letter)?`. var IsClientIDFormat = regexp.MustCompile(`^\w+([\w-]+\w)?-[0-9]{1,20}$`).MatchString // IsValidClientID checks if the clientID is valid and can be parsed into the client diff --git a/modules/core/03-connection/client/cli/query.go b/modules/core/03-connection/client/cli/query.go index 78a672dbfca..18d380e51be 100644 --- a/modules/core/03-connection/client/cli/query.go +++ b/modules/core/03-connection/client/cli/query.go @@ -15,7 +15,7 @@ import ( ) // GetCmdQueryConnections defines the command to query all the connection ends -// that this chain mantains. +// that this chain maintains. func GetCmdQueryConnections() *cobra.Command { cmd := &cobra.Command{ Use: "connections", diff --git a/modules/core/03-connection/keeper/verify.go b/modules/core/03-connection/keeper/verify.go index bee3d460903..1c4d160d368 100644 --- a/modules/core/03-connection/keeper/verify.go +++ b/modules/core/03-connection/keeper/verify.go @@ -369,7 +369,7 @@ func (k Keeper) VerifyNextSequenceRecv( // getBlockDelay calculates the block delay period from the time delay of the connection // and the maximum expected time per block. func (k Keeper) getBlockDelay(ctx sdk.Context, connection exported.ConnectionI) uint64 { - // expectedTimePerBlock should never be zero, however if it is then return a 0 blcok delay for safety + // expectedTimePerBlock should never be zero, however if it is then return a 0 block delay for safety // as the expectedTimePerBlock parameter was not set. expectedTimePerBlock := k.GetParams(ctx).MaxExpectedTimePerBlock if expectedTimePerBlock == 0 { diff --git a/modules/core/03-connection/types/connection.pb.go b/modules/core/03-connection/types/connection.pb.go index 1bd203f3a5e..9ff75f1ccf5 100644 --- a/modules/core/03-connection/types/connection.pb.go +++ b/modules/core/03-connection/types/connection.pb.go @@ -312,7 +312,7 @@ func (m *ConnectionPaths) GetPaths() []string { return nil } -// Version defines the versioning scheme used to negotiate the IBC verison in +// Version defines the versioning scheme used to negotiate the IBC version in // the connection handshake. type Version struct { // unique version identifier diff --git a/modules/core/03-connection/types/genesis.go b/modules/core/03-connection/types/genesis.go index c273f82e363..524bd2282c4 100644 --- a/modules/core/03-connection/types/genesis.go +++ b/modules/core/03-connection/types/genesis.go @@ -41,7 +41,7 @@ func DefaultGenesisState() GenesisState { // failure. func (gs GenesisState) Validate() error { // keep track of the max sequence to ensure it is less than - // the next sequence used in creating connection identifers. + // the next sequence used in creating connection identifiers. var maxSequence uint64 for i, conn := range gs.Connections { diff --git a/modules/core/03-connection/types/tx.pb.go b/modules/core/03-connection/types/tx.pb.go index afe87287690..ee4b1f2d2ea 100644 --- a/modules/core/03-connection/types/tx.pb.go +++ b/modules/core/03-connection/types/tx.pb.go @@ -123,7 +123,7 @@ type MsgConnectionOpenTry struct { DelayPeriod uint64 `protobuf:"varint,5,opt,name=delay_period,json=delayPeriod,proto3" json:"delay_period,omitempty"` CounterpartyVersions []*Version `protobuf:"bytes,6,rep,name=counterparty_versions,json=counterpartyVersions,proto3" json:"counterparty_versions,omitempty"` ProofHeight types1.Height `protobuf:"bytes,7,opt,name=proof_height,json=proofHeight,proto3" json:"proof_height"` - // proof of the initialization the connection on Chain A: `UNITIALIZED -> + // proof of the initialization the connection on Chain A: `UNINITIALIZED -> // INIT` ProofInit []byte `protobuf:"bytes,8,opt,name=proof_init,json=proofInit,proto3" json:"proof_init,omitempty"` // proof of client state included in message @@ -214,7 +214,7 @@ type MsgConnectionOpenAck struct { Version *Version `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"` ClientState *types.Any `protobuf:"bytes,4,opt,name=client_state,json=clientState,proto3" json:"client_state,omitempty"` ProofHeight types1.Height `protobuf:"bytes,5,opt,name=proof_height,json=proofHeight,proto3" json:"proof_height"` - // proof of the initialization the connection on Chain B: `UNITIALIZED -> + // proof of the initialization the connection on Chain B: `UNINITIALIZED -> // TRYOPEN` ProofTry []byte `protobuf:"bytes,6,opt,name=proof_try,json=proofTry,proto3" json:"proof_try,omitempty"` // proof of client state included in message diff --git a/modules/core/04-channel/client/cli/query.go b/modules/core/04-channel/client/cli/query.go index f255e620ab1..21866263a15 100644 --- a/modules/core/04-channel/client/cli/query.go +++ b/modules/core/04-channel/client/cli/query.go @@ -20,7 +20,7 @@ const ( ) // GetCmdQueryChannels defines the command to query all the channels ends -// that this chain mantains. +// that this chain maintains. func GetCmdQueryChannels() *cobra.Command { cmd := &cobra.Command{ Use: "channels", diff --git a/modules/core/04-channel/keeper/handshake_test.go b/modules/core/04-channel/keeper/handshake_test.go index c775e7e6297..988de93045d 100644 --- a/modules/core/04-channel/keeper/handshake_test.go +++ b/modules/core/04-channel/keeper/handshake_test.go @@ -291,7 +291,7 @@ func (suite *KeeperTestSuite) TestChanOpenTry() { suite.chainB.GetContext(), host.ChannelCapabilityPath(path.EndpointB.ChannelConfig.PortID, channelID), ) - suite.Require().True(ok, "could not retrieve channel capapbility after successful ChanOpenTry") + suite.Require().True(ok, "could not retrieve channel capability after successful ChanOpenTry") suite.Require().Equal(chanCap.String(), capability.String(), "channel capability is not correct") } else { suite.Require().Error(err) @@ -499,7 +499,7 @@ func (suite *KeeperTestSuite) TestChanOpenConfirm() { }, true}, {"channel doesn't exist", func() {}, false}, {"channel state is not TRYOPEN", func() { - // create fully open channels on both cahins + // create fully open channels on both chains suite.coordinator.Setup(path) channelCap = suite.chainB.GetChannelCapability(path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID) }, false}, diff --git a/modules/core/04-channel/keeper/keeper.go b/modules/core/04-channel/keeper/keeper.go index f285839799a..f666b09d27b 100644 --- a/modules/core/04-channel/keeper/keeper.go +++ b/modules/core/04-channel/keeper/keeper.go @@ -355,7 +355,7 @@ func (k Keeper) GetAllPacketReceipts(ctx sdk.Context) (receipts []types.PacketSt } // IteratePacketAcknowledgement provides an iterator over all PacketAcknowledgement objects. For each -// aknowledgement, cb will be called. If the cb returns true, the iterator will close +// acknowledgement, cb will be called. If the cb returns true, the iterator will close // and stop. func (k Keeper) IteratePacketAcknowledgement(ctx sdk.Context, cb func(portID, channelID string, sequence uint64, hash []byte) bool) { store := ctx.KVStore(k.storeKey) diff --git a/modules/core/04-channel/types/genesis.go b/modules/core/04-channel/types/genesis.go index fd85574d554..6e9afa0cbae 100644 --- a/modules/core/04-channel/types/genesis.go +++ b/modules/core/04-channel/types/genesis.go @@ -75,7 +75,7 @@ func DefaultGenesisState() GenesisState { // failure. func (gs GenesisState) Validate() error { // keep track of the max sequence to ensure it is less than - // the next sequence used in creating connection identifers. + // the next sequence used in creating connection identifiers. var maxSequence uint64 for i, channel := range gs.Channels { diff --git a/modules/core/04-channel/types/msgs_test.go b/modules/core/04-channel/types/msgs_test.go index e5c027120bb..8221ee95947 100644 --- a/modules/core/04-channel/types/msgs_test.go +++ b/modules/core/04-channel/types/msgs_test.go @@ -25,7 +25,7 @@ import ( ) const ( - // valid constatns used for testing + // valid constants used for testing portid = "testportid" chanid = "channel-0" cpportid = "testcpport" diff --git a/modules/core/client/query.go b/modules/core/client/query.go index 1fa677fc34f..66b10e6e07e 100644 --- a/modules/core/client/query.go +++ b/modules/core/client/query.go @@ -20,7 +20,7 @@ import ( // performed at one below this height (at the IAVL version) in order to obtain // the correct merkle proof. Proof queries at height less than or equal to 2 are // not supported. Queries with a client context height of 0 will perform a query -// at the lastest state available. +// at the latest state available. // Issue: https://github.com/cosmos/cosmos-sdk/issues/6567 func QueryTendermintProof(clientCtx client.Context, key []byte) ([]byte, []byte, clienttypes.Height, error) { height := clientCtx.Height @@ -28,7 +28,7 @@ func QueryTendermintProof(clientCtx client.Context, key []byte) ([]byte, []byte, // ABCI queries at heights 1, 2 or less than or equal to 0 are not supported. // Base app does not support queries for height less than or equal to 1. // Therefore, a query at height 2 would be equivalent to a query at height 3. - // A height of 0 will query with the lastest state. + // A height of 0 will query with the latest state. if height != 0 && height <= 2 { return nil, nil, clienttypes.Height{}, fmt.Errorf("proof queries at height <= 2 are not supported") } diff --git a/modules/core/keeper/msg_server.go b/modules/core/keeper/msg_server.go index 922c365842b..29aa15071e5 100644 --- a/modules/core/keeper/msg_server.go +++ b/modules/core/keeper/msg_server.go @@ -84,7 +84,7 @@ func (k Keeper) UpgradeClient(goCtx context.Context, msg *clienttypes.MsgUpgrade // SubmitMisbehaviour defines a rpc handler method for MsgSubmitMisbehaviour. // Warning: DEPRECATED -// This handler is redudant as `MsgUpdateClient` is now capable of handling both a Header and a Misbehaviour +// This handler is redundant as `MsgUpdateClient` is now capable of handling both a Header and a Misbehaviour func (k Keeper) SubmitMisbehaviour(goCtx context.Context, msg *clienttypes.MsgSubmitMisbehaviour) (*clienttypes.MsgSubmitMisbehaviourResponse, error) { //nolint:staticcheck // for now, we're using msgsubmitmisbehaviour. ctx := sdk.UnwrapSDKContext(goCtx) diff --git a/modules/core/spec/01_concepts.md b/modules/core/spec/01_concepts.md index 475713b0d18..e290facb1a2 100644 --- a/modules/core/spec/01_concepts.md +++ b/modules/core/spec/01_concepts.md @@ -164,10 +164,10 @@ correctness (core logic only). If the packet is valid, a hash of the packet will be stored as a packet commitment using the packet sequence in the key. Packet commitments are stored on the sending chain. -A message should be sent to the receving chain indicating that the packet +A message should be sent to the receiving chain indicating that the packet has been committed on the sending chain and should be received on the receiving chain. The light client on the receiving chain, which verifies -the sending chain's state, should be updated to the lastest sending chain +the sending chain's state, should be updated to the latest sending chain state if possible. The verification will fail if the latest state of the light client does not include the packet commitment. The receiving chain is responsible for verifying that the counterparty set the hash of the diff --git a/modules/light-clients/06-solomachine/client_state.go b/modules/light-clients/06-solomachine/client_state.go index 2f5ec308b3e..1794bc442d3 100644 --- a/modules/light-clients/06-solomachine/client_state.go +++ b/modules/light-clients/06-solomachine/client_state.go @@ -219,7 +219,7 @@ func (cs *ClientState) VerifyNonMembership( return nil } -// produceVerificationArgs perfoms the basic checks on the arguments that are +// produceVerificationArgs performs the basic checks on the arguments that are // shared between the verification functions and returns the public key of the // consensus state, the unmarshalled proof representing the signature and timestamp. func produceVerificationArgs( diff --git a/modules/light-clients/06-solomachine/update_test.go b/modules/light-clients/06-solomachine/update_test.go index 78220c606a1..30a3ff15986 100644 --- a/modules/light-clients/06-solomachine/update_test.go +++ b/modules/light-clients/06-solomachine/update_test.go @@ -81,7 +81,7 @@ func (suite *SoloMachineTestSuite) TestVerifyClientMessageHeader() { { "signature uses new pubkey to sign", func() { - // store in temp before assinging to interface type + // store in temp before assigning to interface type cs := sm.ClientState() h := sm.CreateHeader(sm.Diversifier) @@ -120,7 +120,7 @@ func (suite *SoloMachineTestSuite) TestVerifyClientMessageHeader() { { "signature signs over old pubkey", func() { - // store in temp before assinging to interface type + // store in temp before assigning to interface type cs := sm.ClientState() oldPubKey := sm.PublicKey h := sm.CreateHeader(sm.Diversifier) diff --git a/modules/light-clients/07-tendermint/genesis_test.go b/modules/light-clients/07-tendermint/genesis_test.go index b422698a7fc..b3a03166663 100644 --- a/modules/light-clients/07-tendermint/genesis_test.go +++ b/modules/light-clients/07-tendermint/genesis_test.go @@ -12,7 +12,7 @@ import ( // processed height and processed time per height // then all iteration keys func (suite *TendermintTestSuite) TestExportMetadata() { - // test intializing client and exporting metadata + // test initializing client and exporting metadata path := ibctesting.NewPath(suite.chainA, suite.chainB) suite.coordinator.SetupClients(path) clientStore := suite.chainA.App.GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), path.EndpointA.ClientID) diff --git a/modules/light-clients/07-tendermint/misbehaviour_handle_test.go b/modules/light-clients/07-tendermint/misbehaviour_handle_test.go index d4719ab016b..d0b9ed68001 100644 --- a/modules/light-clients/07-tendermint/misbehaviour_handle_test.go +++ b/modules/light-clients/07-tendermint/misbehaviour_handle_test.go @@ -72,7 +72,7 @@ func (suite *TendermintTestSuite) TestVerifyMisbehaviour() { true, }, { - "valid time misbehaviour, header 1 time stricly less than header 2 time", func() { + "valid time misbehaviour, header 1 time strictly less than header 2 time", func() { trustedHeight := path.EndpointA.GetClientState().GetLatestHeight().(clienttypes.Height) trustedVals, found := suite.chainB.GetValsAtHeight(int64(trustedHeight.RevisionHeight)) @@ -420,7 +420,7 @@ func (suite *TendermintTestSuite) TestVerifyMisbehaviourNonRevisionChainID() { true, }, { - "valid time misbehaviour, header 1 time stricly less than header 2 time", func() { + "valid time misbehaviour, header 1 time strictly less than header 2 time", func() { trustedHeight := path.EndpointA.GetClientState().GetLatestHeight().(clienttypes.Height) trustedVals, found := suite.chainB.GetValsAtHeight(int64(trustedHeight.RevisionHeight)) diff --git a/modules/light-clients/07-tendermint/module.go b/modules/light-clients/07-tendermint/module.go index 3ff358884e0..9f28bd6613b 100644 --- a/modules/light-clients/07-tendermint/module.go +++ b/modules/light-clients/07-tendermint/module.go @@ -55,7 +55,7 @@ func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage { return nil } -// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light cilent. +// ValidateGenesis performs a no-op. Genesis is not supported for the tendermint light client. func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error { return nil } diff --git a/modules/light-clients/07-tendermint/store.go b/modules/light-clients/07-tendermint/store.go index d1978fe6034..1dce3bbf521 100644 --- a/modules/light-clients/07-tendermint/store.go +++ b/modules/light-clients/07-tendermint/store.go @@ -23,7 +23,7 @@ stores the consensus state under the key: `consensusStates/{revision_number}-{re represented as a string. While this works fine for IBC proof verification, it makes efficient iteration difficult since the lexicographic order of the consensus state keys do not match the height order of consensus states. This makes consensus state pruning and -monotonic time enforcement difficult since it is inefficient to find the earliest consensus state or to find the neigboring +monotonic time enforcement difficult since it is inefficient to find the earliest consensus state or to find the neighboring consensus states given a consensus state height. Changing the ICS-24 representation will be a major breaking change that requires counterparty chains to accept a new key format. Thus to avoid breaking IBC, we can store a lookup from a more efficiently formatted key: `iterationKey` to the consensus state key which diff --git a/modules/light-clients/07-tendermint/update.go b/modules/light-clients/07-tendermint/update.go index 092d1161401..4b3a893706a 100644 --- a/modules/light-clients/07-tendermint/update.go +++ b/modules/light-clients/07-tendermint/update.go @@ -156,7 +156,7 @@ func (cs ClientState) UpdateState(ctx sdk.Context, cdc codec.BinaryCodec, client NextValidatorsHash: header.Header.NextValidatorsHash, } - // set client state, consensus state and asssociated metadata + // set client state, consensus state and associated metadata setClientState(clientStore, cdc, &cs) setConsensusState(clientStore, cdc, consensusState, header.GetHeight()) setConsensusMetadata(ctx, clientStore, header.GetHeight()) diff --git a/modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go b/modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go index 5b57a2f0d0b..2ddbeb6b0d3 100644 --- a/modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go +++ b/modules/light-clients/08-wasm/internal/ibcwasm/expected_interfaces.go @@ -77,11 +77,11 @@ type WasmEngine interface { deserCost wasmvmtypes.UFraction, ) (*wasmvmtypes.Response, uint64, error) - // Sudo allows native Go modules to make priviledged (sudo) calls on the contract. + // Sudo allows native Go modules to make privileged (sudo) calls on the contract. // The contract can expose entry points that cannot be triggered by any transaction, but only via // native Go modules, and delegate the access control to the system. // - // These work much like Migrate (same scenario) but allows custom apps to extend the priviledged entry points + // These work much like Migrate (same scenario) but allows custom apps to extend the privileged entry points // without forking cosmwasm-vm. Sudo( checksum wasmvm.Checksum, diff --git a/modules/light-clients/08-wasm/testing/simapp/app.go b/modules/light-clients/08-wasm/testing/simapp/app.go index d3794fb8896..c1e2e3790e6 100644 --- a/modules/light-clients/08-wasm/testing/simapp/app.go +++ b/modules/light-clients/08-wasm/testing/simapp/app.go @@ -448,7 +448,7 @@ func NewSimApp( // Both x/wasm's Keeper and 08-wasm Keeper should share the same Wasm VM instance. // - Instantiate the Wasm VM in app.go with the parameters of your choice. // - Create an Option with this Wasm VM instance (see https://github.com/CosmWasm/wasmd/blob/v0.41.0/x/wasm/keeper/options.go#L26-L32). - // - Pass the option to the x/wasm NewKeeper contructor function (https://github.com/CosmWasm/wasmd/blob/v0.41.0/x/wasm/keeper/keeper_cgo.go#L36). + // - Pass the option to the x/wasm NewKeeper constructor function (https://github.com/CosmWasm/wasmd/blob/v0.41.0/x/wasm/keeper/keeper_cgo.go#L36). // - Pass a pointer to the Wasm VM instance to 08-wasm NewKeeperWithVM constructor function. // // 2. If the chain does not use x/wasm: diff --git a/modules/light-clients/08-wasm/testing/simapp/params/amino.go b/modules/light-clients/08-wasm/testing/simapp/params/amino.go index d603987dd5f..c7d8ba0045d 100644 --- a/modules/light-clients/08-wasm/testing/simapp/params/amino.go +++ b/modules/light-clients/08-wasm/testing/simapp/params/amino.go @@ -11,7 +11,7 @@ import ( // MakeTestEncodingConfig creates an EncodingConfig for an amino based test configuration. // This function should be used only internally (in the SDK). -// App user should'nt create new codecs - use the app.AppCodec instead. +// App user shouldn't create new codecs - use the app.AppCodec instead. // [DEPRECATED] func MakeTestEncodingConfig() EncodingConfig { cdc := codec.NewLegacyAmino() diff --git a/modules/light-clients/08-wasm/testing/simapp/params/proto.go b/modules/light-clients/08-wasm/testing/simapp/params/proto.go index 4270c2b0dbf..73702a15abf 100644 --- a/modules/light-clients/08-wasm/testing/simapp/params/proto.go +++ b/modules/light-clients/08-wasm/testing/simapp/params/proto.go @@ -11,7 +11,7 @@ import ( // MakeTestEncodingConfig creates an EncodingConfig for a non-amino based test configuration. // This function should be used only internally (in the SDK). -// App user should'nt create new codecs - use the app.AppCodec instead. +// App user shouldn't create new codecs - use the app.AppCodec instead. // [DEPRECATED] func MakeTestEncodingConfig() EncodingConfig { cdc := codec.NewLegacyAmino() diff --git a/proto/ibc/core/connection/v1/connection.proto b/proto/ibc/core/connection/v1/connection.proto index 852f3999bf6..5b4554cab5e 100644 --- a/proto/ibc/core/connection/v1/connection.proto +++ b/proto/ibc/core/connection/v1/connection.proto @@ -94,7 +94,7 @@ message ConnectionPaths { repeated string paths = 2; } -// Version defines the versioning scheme used to negotiate the IBC verison in +// Version defines the versioning scheme used to negotiate the IBC version in // the connection handshake. message Version { option (gogoproto.goproto_getters) = false; diff --git a/proto/ibc/core/connection/v1/tx.proto b/proto/ibc/core/connection/v1/tx.proto index 3ba8ff45660..8e59c27d5a7 100644 --- a/proto/ibc/core/connection/v1/tx.proto +++ b/proto/ibc/core/connection/v1/tx.proto @@ -65,7 +65,7 @@ message MsgConnectionOpenTry { uint64 delay_period = 5; repeated Version counterparty_versions = 6; ibc.core.client.v1.Height proof_height = 7 [(gogoproto.nullable) = false]; - // proof of the initialization the connection on Chain A: `UNITIALIZED -> + // proof of the initialization the connection on Chain A: `UNINITIALIZED -> // INIT` bytes proof_init = 8; // proof of client state included in message @@ -93,7 +93,7 @@ message MsgConnectionOpenAck { Version version = 3; google.protobuf.Any client_state = 4; ibc.core.client.v1.Height proof_height = 5 [(gogoproto.nullable) = false]; - // proof of the initialization the connection on Chain B: `UNITIALIZED -> + // proof of the initialization the connection on Chain B: `UNINITIALIZED -> // TRYOPEN` bytes proof_try = 6; // proof of client state included in message diff --git a/scripts/hooks/pre-commit.sh b/scripts/hooks/pre-commit.sh index dfc38c57fd5..e8e4a700ffe 100755 --- a/scripts/hooks/pre-commit.sh +++ b/scripts/hooks/pre-commit.sh @@ -6,7 +6,7 @@ function check_golangci_lint_version(){ local git_root="$(git rev-parse --show-toplevel)" - # Note: we are explicitly stripping out the 'v' prefix from the versions. Different verisons of + # Note: we are explicitly stripping out the 'v' prefix from the versions. Different versions of # golangci-lint have different version formats. For example, v1.27.0 (if installed with go get) vs 1.27.0 (installed with curl). # extract the version of golangci-lint from the CI workflow file. diff --git a/testing/README.md b/testing/README.md index bfe7c688dfa..dfef3e73604 100644 --- a/testing/README.md +++ b/testing/README.md @@ -175,7 +175,7 @@ func (suite *KeeperTestSuite) SetupTest() { ``` -To create interaction between chainA and chainB, we need to contruct a `Path` these chains will use. +To create interaction between chainA and chainB, we need to construct a `Path` these chains will use. A path contains two endpoints, `EndpointA` and `EndpointB` (corresponding to the order of the chains passed into the `NewPath` function). A path is a pointer and its values will be filled in as necessary during the setup portion of testing. @@ -203,7 +203,7 @@ type Endpoint struct { The fields empty after `NewPath` is called are `ClientID`, `ConnectionID` and `ChannelID` as the clients, connections, and channels for these endpoints have not yet been created. The `ClientConfig`, `ConnectionConfig` and `ChannelConfig` contain all the necessary information for clients, -connections, and channels to be initialized. If you would like to use endpoints which are intitialized to +connections, and channels to be initialized. If you would like to use endpoints which are initialized to use your Port IDs, you might add a helper function similar to the one found in transfer: ```go diff --git a/testing/simapp/params/amino.go b/testing/simapp/params/amino.go index d603987dd5f..c7d8ba0045d 100644 --- a/testing/simapp/params/amino.go +++ b/testing/simapp/params/amino.go @@ -11,7 +11,7 @@ import ( // MakeTestEncodingConfig creates an EncodingConfig for an amino based test configuration. // This function should be used only internally (in the SDK). -// App user should'nt create new codecs - use the app.AppCodec instead. +// App user shouldn't create new codecs - use the app.AppCodec instead. // [DEPRECATED] func MakeTestEncodingConfig() EncodingConfig { cdc := codec.NewLegacyAmino() diff --git a/testing/simapp/params/proto.go b/testing/simapp/params/proto.go index 4270c2b0dbf..73702a15abf 100644 --- a/testing/simapp/params/proto.go +++ b/testing/simapp/params/proto.go @@ -11,7 +11,7 @@ import ( // MakeTestEncodingConfig creates an EncodingConfig for a non-amino based test configuration. // This function should be used only internally (in the SDK). -// App user should'nt create new codecs - use the app.AppCodec instead. +// App user shouldn't create new codecs - use the app.AppCodec instead. // [DEPRECATED] func MakeTestEncodingConfig() EncodingConfig { cdc := codec.NewLegacyAmino()