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 error message when scanning unsupported client #3531

Closed
5 tasks
romac opened this issue Aug 14, 2023 · 0 comments · Fixed by #3567
Closed
5 tasks

Improve error message when scanning unsupported client #3531

romac opened this issue Aug 14, 2023 · 0 comments · Fixed by #3567
Labels
A: easy Admin: tasks that are easy to implement A: good-first-issue Admin: good for newcomers
Milestone

Comments

@romac
Copy link
Member

romac commented Aug 14, 2023

Summary

Problem definition

During scanning, when we encounter an unsupported type of client (for example, a localhost client), the relayer outputs the following error, which while benign because the client will just be skipped, should be improved to not give the impression that the relayer is malfunctioning.

2023-08-14T08:23:23.191084Z  INFO scan.chain{chain=ibcconsumer}: ibc_relayer::supervisor::scan: scanning all clients...
2023-08-14T08:23:23.193751Z  WARN scan.chain{chain=ibcconsumer}: ibc_relayer::chain::cosmos: failed to parse client state IdentifiedClientState { client_id: 09-localhost, client_state: Any { type_url: /ibc.lightclients.localhost.v2.ClientState } }. Error: unknown client state type: /ibc.lightclients.localhost.v2.ClientState

Location:
    /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/flex-error-0.4.4/src/tracer_impl/eyre.rs:10:9

Proposal

Improve the error message above to something like:

encountered unsupported client type `/ibc.lightclients.localhost.v2.ClientState` while scanning client `09-localhost`, skipping the client

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 Aug 14, 2023
@romac romac added this to the v1.7 milestone Aug 22, 2023
@romac romac moved this from 🩹 Triage to 📥 Todo in Hermes Aug 22, 2023
@romac romac added A: good-first-issue Admin: good for newcomers A: easy Admin: tasks that are easy to implement labels Aug 23, 2023
@github-project-automation github-project-automation bot moved this from 📥 Todo to ✅ Done in Hermes Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: easy Admin: tasks that are easy to implement A: good-first-issue Admin: good for newcomers
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant