-
Notifications
You must be signed in to change notification settings - Fork 332
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
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
66c8f54
Start guide section on configuring CCV chains
seanchen1991 76d3c69
Flesh out config section on relaying for consumer chains
seanchen1991 cd824a0
Add troubleshooting section on configuring consumer chains
seanchen1991 771fa03
Merge branch 'master' into sean/document-ccv
seanchen1991 f79aaa9
Incorporate PR feedback
seanchen1991 e5ec925
Merge branch 'sean/document-ccv' of https://github.com/informalsystem…
seanchen1991 a3ff0ef
Merge branch 'master' into sean/document-ccv
seanchen1991 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -115,6 +115,24 @@ list = [ | |||||
] | ||||||
``` | ||||||
|
||||||
## Configuring Support for Consumer Chains that Utilize Cross-Chain Validation | ||||||
|
||||||
As of version 1.4.1, Hermes supports relaying for consumer chains that utilize [cross-chain validation][ccv] (CCV). | ||||||
|
||||||
> **Note:** A consumer chain is essentially a regular Cosmos-SDK based chain that uses the interchain security | ||||||
module to achieve economic security by stake deposited on a provider chain instead of on the consumer chain | ||||||
itself. Consumer chains are bound to their provider chains by the provider's validator set. By being bound | ||||||
together in this way, consumer chains inherit the economic security guarantees of the provider chain. | ||||||
> | ||||||
> 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
By default, this option is set to `false`. It should *ONLY* be toggled on for CCV consumer chains, *NOT* for sovereign chains. | ||||||
|
||||||
This parameter is required because consumer chains do not utilize the same staking module as sovereign chains. | ||||||
Consumer chains must query a different gRPC endpoint in order to fetch the relevant `ccvconsumer` parameters that Hermes | ||||||
needs in order to relay on behalf of consumer chains. | ||||||
|
||||||
## Connecting to a full node protected by HTTP Basic Authentication | ||||||
|
||||||
To connect to a full node protected by [HTTP Basic Authentication][http-basic-auth], | ||||||
|
@@ -165,6 +183,8 @@ be receiving, such as when relaying for CosmWasm-enabled blockchains which emit | |||||
`message` attribute. Without this attribute, the WebSocket is not able to catch these events to stream | ||||||
to Hermes, so the `/block_results` RPC endpoint must be used instead. | ||||||
|
||||||
[ccv]: https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md | ||||||
[cosmos-github-io]: https://cosmos.github.io/interchain-security | ||||||
[http-basic-auth]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication | ||||||
[ica]: https://github.com/cosmos/ibc/blob/master/spec/app/ics-027-interchain-accounts/README.md | ||||||
[chain-registry]: https://github.com/cosmos/chain-registry | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.