From 2b58f10a787d99771602638e4fbe9f23a42d1963 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 2 Oct 2023 08:46:50 +0200 Subject: [PATCH] fix: typos (#4796) * fix typo * fix typo * fix typos * fix typos * fix typos * fix typo --- docs/docs/01-ibc/02-integration.md | 6 +++--- docs/docs/01-ibc/03-apps/01-apps.md | 6 +++--- docs/docs/01-ibc/03-apps/02-ibcmodule.md | 2 +- docs/docs/01-ibc/09-roadmap.md | 6 +++--- docs/docs/02-apps/01-transfer/07-params.md | 2 +- docs/docs/03-light-clients/02-localhost/03-client-state.md | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/docs/01-ibc/02-integration.md b/docs/docs/01-ibc/02-integration.md index ed67606f399..5a3ea531ae1 100644 --- a/docs/docs/01-ibc/02-integration.md +++ b/docs/docs/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 @@ -150,7 +150,7 @@ Once the `Router` has been set, no new routes can be added. func NewApp(...args) *App { // .. continuation from above - // Create static IBC router, add ibc-tranfer module route, then set and seal it + // Create static IBC router, add ibc-transfer module route, then set and seal it ibcRouter := port.NewRouter() ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule) // Setting Router will finalize all routes by sealing router @@ -195,7 +195,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 title="app.go" func NewApp(...args) *App { diff --git a/docs/docs/01-ibc/03-apps/01-apps.md b/docs/docs/01-ibc/03-apps/01-apps.md index a80747c7642..05d903c85a8 100644 --- a/docs/docs/01-ibc/03-apps/01-apps.md +++ b/docs/docs/01-ibc/03-apps/01-apps.md @@ -182,7 +182,7 @@ a subset of features supported by your application for that version. The struct scheme can be found in `03-connection/types`. 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. @@ -222,9 +222,9 @@ channel, as well as how they will encode/decode it. This process is not specifie to each application module to determine how to implement this agreement. However, for most applications this will happen as a version negotiation during the channel handshake. While more complex version negotiation is possible to implement inside the channel opening handshake, a very -simple version negotation is implemented in the [ibc-transfer module](https://github.com/cosmos/ibc-go/tree/main/modules/apps/transfer/module.go). +simple version negotiation is implemented in the [ibc-transfer module](https://github.com/cosmos/ibc-go/tree/main/modules/apps/transfer/module.go). -Thus, a module must define its a custom packet data structure, along with a well-defined way to +Thus, a module must define its custom packet data structure, along with a well-defined way to encode and decode it to and from `[]byte`. ```go diff --git a/docs/docs/01-ibc/03-apps/02-ibcmodule.md b/docs/docs/01-ibc/03-apps/02-ibcmodule.md index 5d5f499e7b7..d128612fab2 100644 --- a/docs/docs/01-ibc/03-apps/02-ibcmodule.md +++ b/docs/docs/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/docs/01-ibc/09-roadmap.md b/docs/docs/01-ibc/09-roadmap.md index a4e1836d273..cfb537adcca 100644 --- a/docs/docs/01-ibc/09-roadmap.md +++ b/docs/docs/01-ibc/09-roadmap.md @@ -17,7 +17,7 @@ This roadmap should be read as a high-level guide, rather than a commitment to s Follow the progress with the [milestone](https://github.com/cosmos/ibc-go/milestone/38). -This release main addtions are: +This release main additions are: - Upgrade to Cosmos SDK v0.50. - [Migration of gov proposals from v1beta1 to v1](https://github.com/cosmos/ibc-go/issues/1282). @@ -35,7 +35,7 @@ This feature has been developed by Composable and Strangelove. ### Channel upgradability -Channel upgradability will allow chains to renegotiate an existing channel to take advantage of new features without having to create a new channel, thus preserving all existing packet state processed on the channel. This feature will enable, for example, the adoption on existing channels of features like [path unwinding](https://github.com/cosmos/ibc/discussions/824) or fee middleware. +Channel upgradability will allow chains to renegotiate an existing channel to take advantage of new features without having to create a new channel, thus preserving all existing packet state processed on the channel. This feature will enable, for example, the adoption of existing channels of features like [path unwinding](https://github.com/cosmos/ibc/discussions/824) or fee middleware. Follow the progress with the [alpha milestone](https://github.com/cosmos/ibc-go/milestone/29) or the [project board](https://github.com/orgs/cosmos/projects/7/views/17). @@ -45,7 +45,7 @@ This roadmap is also available as a [project board](https://github.com/orgs/cosm For the latest expected release timelines, please check [here](https://github.com/cosmos/ibc-go/wiki/Release-timeline). -For the latest information on the progress of the work or the decisions made that might influence the roadmap, please follow the [Annoucements](https://github.com/cosmos/ibc-go/discussions/categories/announcements) category in the Discussions tab of the repository. +For the latest information on the progress of the work or the decisions made that might influence the roadmap, please follow the [Announcements](https://github.com/cosmos/ibc-go/discussions/categories/announcements) category in the Discussions tab of the repository. --- diff --git a/docs/docs/02-apps/01-transfer/07-params.md b/docs/docs/02-apps/01-transfer/07-params.md index 365fc21c3e3..635344edea4 100644 --- a/docs/docs/02-apps/01-transfer/07-params.md +++ b/docs/docs/02-apps/01-transfer/07-params.md @@ -79,7 +79,7 @@ To change the parameter values, you must make a governance proposal that execute // MsgUpdateParams is the Msg/UpdateParams request type. message MsgUpdateParams { - // signer address (it may be the the address that controls the module, which defaults to x/gov unless overwritten). + // signer address (it may be the address that controls the module, which defaults to x/gov unless overwritten). string signer = 1; // params defines the transfer parameters to update. diff --git a/docs/docs/03-light-clients/02-localhost/03-client-state.md b/docs/docs/03-light-clients/02-localhost/03-client-state.md index 5f0a990412e..19e03b62aa9 100644 --- a/docs/docs/03-light-clients/02-localhost/03-client-state.md +++ b/docs/docs/03-light-clients/02-localhost/03-client-state.md @@ -47,7 +47,7 @@ func BeginBlocker(ctx sdk.Context, k keeper.Keeper) { } ``` -The above calls into the the 09-localhost `UpdateState` method of the `ClientState` . +The above calls into the 09-localhost `UpdateState` method of the `ClientState` . It retrieves the current block height from the application context and sets the `LatestHeight` of the 09-localhost client. ```go