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

Add documentation on relaying for consumer chains to the Hermes guide #3407

Merged
merged 7 commits into from
Jun 8, 2023

Conversation

seanchen1991
Copy link
Contributor

Closes: #3349

Description


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@seanchen1991 seanchen1991 requested a review from ancazamfir June 7, 2023 16:53

## Unimplemented gRPC for Cosmos Staking Service

When relaying for a consumer chain, the `ccv_consumer_chain` parameter in `config.toml` *must* be set to `true`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When relaying for a consumer chain, the `ccv_consumer_chain` parameter in `config.toml` *must* be set to `true`.
When relaying for a consumer chain, the `ccv_consumer_chain` parameter *must* be set to `true` under its `[[chains]]` section in the `config.toml` file.

>
> You can read more about consumer chains, and Interchain Security more generally, at [https://cosmos.github.io/interchain-security][cosmos-github-io].

If you are configuring Hermes in order to relay for a consumer chain, set `ccv_consumer_chain = true` in the `config.toml` file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are configuring Hermes in order to relay for a consumer chain, set `ccv_consumer_chain = true` in the `config.toml` file.
If you are configuring Hermes in order to relay for a consumer chain, set `ccv_consumer_chain = true` under its `[[chains]]` section in the `config.toml` file.

@romac romac merged commit 6d7f761 into master Jun 8, 2023
@romac romac deleted the sean/document-ccv branch June 8, 2023 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for consumer chain relaying
2 participants