From ebe19d510459141ecdfb0a6fc2184fd191559da4 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Date: Fri, 22 Mar 2024 08:58:14 +0100 Subject: [PATCH] lint --- .../01-developer-guide/02-light-client-module.md | 2 +- .../01-developer-guide/05-updates-and-misbehaviour.md | 2 +- docs/docs/03-light-clients/04-wasm/02-concepts.md | 1 + docs/docs/03-light-clients/04-wasm/03-integration.md | 6 +++--- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/docs/03-light-clients/01-developer-guide/02-light-client-module.md b/docs/docs/03-light-clients/01-developer-guide/02-light-client-module.md index dfb5603ec7a..6db45e744e2 100644 --- a/docs/docs/03-light-clients/01-developer-guide/02-light-client-module.md +++ b/docs/docs/03-light-clients/01-developer-guide/02-light-client-module.md @@ -77,4 +77,4 @@ has already been verified. See section [`CheckForMisbehaviour`](05-updates-and-m ## `VerifyUpgradeAndUpdateState` method -`VerifyUpgradeAndUpdateState` provides a path to upgrading clients given an upgraded `ClientState`, upgraded `ConsensusState` and proofs for each. See section [Implementing `VerifyUpgradeAndUpdateState`](./06-upgrades.md#implementing-verifyupgradeandupdatestate) for more information. \ No newline at end of file +`VerifyUpgradeAndUpdateState` provides a path to upgrading clients given an upgraded `ClientState`, upgraded `ConsensusState` and proofs for each. See section [Implementing `VerifyUpgradeAndUpdateState`](./06-upgrades.md#implementing-verifyupgradeandupdatestate) for more information. diff --git a/docs/docs/03-light-clients/01-developer-guide/05-updates-and-misbehaviour.md b/docs/docs/03-light-clients/01-developer-guide/05-updates-and-misbehaviour.md index d882ff23192..57b92a0fcc1 100644 --- a/docs/docs/03-light-clients/01-developer-guide/05-updates-and-misbehaviour.md +++ b/docs/docs/03-light-clients/01-developer-guide/05-updates-and-misbehaviour.md @@ -101,4 +101,4 @@ if foundMisbehaviour { clientModule.UpdateState(ctx, clientID, clientMsg) // expects no-op on duplicate header // emit update event return -``` \ No newline at end of file +``` diff --git a/docs/docs/03-light-clients/04-wasm/02-concepts.md b/docs/docs/03-light-clients/04-wasm/02-concepts.md index 12958dc1258..978b77d3c73 100644 --- a/docs/docs/03-light-clients/04-wasm/02-concepts.md +++ b/docs/docs/03-light-clients/04-wasm/02-concepts.md @@ -26,6 +26,7 @@ type LightClientModule struct { storeProvider exported.ClientStoreProvider } ``` + See section [`LightClientModule` of the light client module developer guide](../01-developer-guide/01-overview.md#lightclientmodule) for more information about the `LightClientModule` interface. ### `ClientState` diff --git a/docs/docs/03-light-clients/04-wasm/03-integration.md b/docs/docs/03-light-clients/04-wasm/03-integration.md index f9732d6820b..6aa61d9ffa5 100644 --- a/docs/docs/03-light-clients/04-wasm/03-integration.md +++ b/docs/docs/03-light-clients/04-wasm/03-integration.md @@ -11,7 +11,7 @@ Learn how to integrate the `08-wasm` module in a chain binary and about the reco ## `app.go` setup -The sample code below shows the relevant integration points in `app.go` required to setup the `08-wasm` module in a chain binary. Since `08-wasm` is a light client module itself, please check out as well the section [Integrating light clients](../../01-ibc/02-integration.md#integrating-light-clients) for more information: +The sample code below shows the relevant integration points in `app.go` required to set up the `08-wasm` module in a chain binary. Since `08-wasm` is a light client module itself, please check out as well the section [Integrating light clients](../../01-ibc/02-integration.md#integrating-light-clients) for more information: ```go // app.go @@ -130,13 +130,13 @@ func NewSimApp( ## Keeper instantiation -When it comes to instantiating `08-wasm`'s keeper there are two recommended ways of doing it. Choosing one or the other will depend on whether the chain already integrates [`x/wasm`](https://github.com/CosmWasm/wasmd/tree/main/x/wasm) or not. +When it comes to instantiating `08-wasm`'s keeper, there are two recommended ways of doing it. Choosing one or the other will depend on whether the chain already integrates [`x/wasm`](https://github.com/CosmWasm/wasmd/tree/main/x/wasm) or not. ### If `x/wasm` is present If the chain where the module is integrated uses `x/wasm` then we recommend that both `08-wasm` and `x/wasm` share the same Wasm VM instance. Having two separate Wasm VM instances is still possible, but care should be taken to make sure that both instances do not share the directory when the VM stores blobs and various caches, otherwise unexpected behaviour is likely to happen (from `x/wasm` v0.51 and `08-wasm` v0.2.0.0+ibc-go-v8.2-wasmvm-v2.0 this will be forbidden anyway, since wasmvm v2.0.0 and above will not allow two different Wasm VM instances to shared the same data folder). -In order to share the Wasm VM instance please follow the guideline below. Please note that this requires `x/wasm` v0.41 or above. +In order to share the Wasm VM instance, please follow the guideline below. Please note that this requires `x/wasm` v0.41 or above. - Instantiate the Wasm VM in `app.go` with the parameters of your choice. - [Create an `Option` with this Wasm VM instance](https://github.com/CosmWasm/wasmd/blob/db93d7b6c7bb6f4a340d74b96a02cec885729b59/x/wasm/keeper/options.go#L21-L25).