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

Improve documentation for consumer chain relaying #3349

Closed
7 tasks
Tracked by #3175
ancazamfir opened this issue May 18, 2023 · 0 comments · Fixed by #3407
Closed
7 tasks
Tracked by #3175

Improve documentation for consumer chain relaying #3349

ancazamfir opened this issue May 18, 2023 · 0 comments · Fixed by #3407
Assignees
Labels
I: documentation Internal: improvements or additions to documentation O: ics27-ica Objective: ICS 027, Interchain Accounts
Milestone

Comments

@ancazamfir
Copy link
Collaborator

ancazamfir commented May 18, 2023

Summary

For successful relaying on consumer chains hermes needs to be explicitly configured with ccv_consumer_chain = true. This is described in the config file but I think it deserves a dedicated section as for ICA for example:
https://hermes.informal.systems/documentation/configuration/configure-hermes.html#support-for-interchain-accounts

Problem Definition

So far almost all operators ran into misconfiguration issue for consumer chains.

Acceptance Criteria

Clear documentation for ICS

  • Add a section to the "Configuration" section talking about the ccv_consumer_chain option
  • Add a section to the "Troubleshooting" section on errors that might occur when the
    ccv_consumer_chain flag is not set when attempting to relay for a consumer chain

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@github-project-automation github-project-automation bot moved this to 🩹 Triage in Hermes May 18, 2023
@seanchen1991 seanchen1991 moved this from 🩹 Triage to 📥 Todo in Hermes May 18, 2023
@seanchen1991 seanchen1991 added I: documentation Internal: improvements or additions to documentation O: ics27-ica Objective: ICS 027, Interchain Accounts labels May 18, 2023
@seanchen1991 seanchen1991 added this to the v1.6 milestone May 18, 2023
@seanchen1991 seanchen1991 self-assigned this May 18, 2023
@seanchen1991 seanchen1991 moved this from 📥 Todo to 🏗 In progress in Hermes Jun 6, 2023
@seanchen1991 seanchen1991 moved this from 🏗 In progress to 👀 In review in Hermes Jun 7, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Hermes Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: documentation Internal: improvements or additions to documentation O: ics27-ica Objective: ICS 027, Interchain Accounts
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants