Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aggregate troubleshooting page into integration, remove duplicate protobuf #8144

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/docs/01-ibc/02-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,11 @@ var (
)
```

#### Integrating light clients
### Integrating light clients

> Note that from v9 onwards, all light clients are expected to implement the [`LightClientInterface` interface](../03-light-clients/01-developer-guide/02-light-client-module.md#implementing-the-lightclientmodule-interface) defined by core IBC, and have to be explicitly registered in a chain's app.go. This is in contrast to earlier versions of ibc-go when `07-tendermint` and `06-solomachine` were added out of the box. Follow the steps below to integrate the `07-tendermint` light client.
> Note that from v7 onwards, all light clients are expected to implement the [`LightClientInterface` interface](../03-light-clients/01-developer-guide/02-light-client-module.md#implementing-the-lightclientmodule-interface) defined by core IBC, and have to be explicitly registered in a chain's app.go. This is in contrast to earlier versions of ibc-go when `07-tendermint` and `06-solomachine` were added out of the box. Follow the steps below to integrate the `07-tendermint` light client.

All light clients must be registered with `module.Manager` in a chain's app.go file.

The following code example shows how to instantiate `07-tendermint` light client module and register its `ibctm.AppModule`.
All light clients must be registered with `module.Manager` in a chain's app.go file. The following code example shows how to instantiate `07-tendermint` light client module and register its `ibctm.AppModule`.

```go title="app.go"
import (
Expand Down Expand Up @@ -253,6 +251,16 @@ app.ModuleManager = module.NewManager(
)
```

#### Allowed Clients Params

The allowed clients parameter defines an allow list of client types supported by the chain. The
default value is a single-element list containing the [`AllowedClients`](https://github.com/cosmos/ibc-go/blob/main/modules/core/02-client/types/client.pb.go#L248-L253) wildcard (`"*"`). Alternatively, the parameter
may be set with a list of client types (e.g. `"06-solomachine","07-tendermint","09-localhost"`).
A client type that is not registered on this list will fail upon creation or on genesis validation.
Note that, since the client type is an arbitrary string, chains must not register two light clients
which return the same value for the `ClientType()` function, otherwise the allow list check can be
bypassed.

### Application ABCI ordering

One addition from IBC is the concept of `HistoricalInfo` which is stored in the Cosmos SDK `x/staking` module. The number of records stored by `x/staking` is controlled by the `HistoricalEntries` parameter which stores `HistoricalInfo` on a per-height basis.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/01-ibc/06-proposals.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Governance Proposals
sidebar_label: Governance Proposals
sidebar_position: 7
sidebar_position: 6
slug: /ibc/proposals
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/01-ibc/07-relayer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Relayer
sidebar_label: Relayer
sidebar_position: 8
sidebar_position: 7
slug: /ibc/relayer
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Best Practices
sidebar_label: Best Practices
sidebar_position: 13
sidebar_position: 8
slug: /ibc/best-practices
---

Expand Down
11 changes: 0 additions & 11 deletions docs/docs/01-ibc/08-proto-docs.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Permissioning
sidebar_label: Permissioning
sidebar_position: 14
sidebar_position: 9
slug: /ibc/permissioning
---

Expand Down
15 changes: 0 additions & 15 deletions docs/docs/01-ibc/10-troubleshooting.md

This file was deleted.

Loading