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

User-facing CLI to clear packets #1716

Closed
5 of 6 tasks
adizere opened this issue Dec 25, 2021 · 0 comments · Fixed by #1834
Closed
5 of 6 tasks

User-facing CLI to clear packets #1716

adizere opened this issue Dec 25, 2021 · 0 comments · Fixed by #1834
Assignees
Labels
A: good-first-issue Admin: good for newcomers I: CLI Internal: related to the relayer's CLI O: new-feature Objective: cause to add a new feature or support O: usability Objective: cause to improve the user experience (UX) and ease using the product
Milestone

Comments

@adizere
Copy link
Member

adizere commented Dec 25, 2021

Crate

ibc-relayer-cli

Problem Definition

Currently, Hermes operators need to specify two separate tx raw commands to achieve complete packet clearing of a given path, specifically:

  • hermes tx raw packet-recv <OPTIONS>
  • hermes tx raw packet-ack <OPTIONS>

This is clumsy for two reasons: (1) because tx raw is not meant to be user-facing, yet operators have no other way to achieve packet clearing, and (2) because operators need two separate commands both of which are notoriously complex due to the many positional arguments that these commands expect.

Proposal

This is a relayer operator suggestion.

We should provide a single CLI that unifies the two raw packet-recv + raw packet-ack commands.

Just like we have a "packet setup" user-facing commands, we should also have "packet clearing" commands.

Concretely: add a CLI

  • hermes clear packets

with the following specification --

POSITIONAL ARGUMENTS:
    dst_chain_id              identifier of the destination chain
    src_chain_id              identifier of the source chain
    src_port_id               identifier of the source port
    src_channel_id            identifier of the source channel

The new CLI should act similarly to packet-recv and packet-ack commands, and should perform packet clearing in both directions of the given channel.

Acceptance Criteria

  • one new user-facing CLI, hermes clear packets with the semantics described above

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@adizere adizere added O: new-feature Objective: cause to add a new feature or support A: good-first-issue Admin: good for newcomers I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product P-medium labels Dec 25, 2021
@adizere adizere added this to the v0.10.1 milestone Dec 25, 2021
@adizere adizere modified the milestones: v0.11.0, v0.11.1 Jan 21, 2022
@romac romac modified the milestones: v0.11.1, v0.12.0 Feb 2, 2022
@romac romac mentioned this issue Feb 18, 2022
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: good-first-issue Admin: good for newcomers I: CLI Internal: related to the relayer's CLI O: new-feature Objective: cause to add a new feature or support O: usability Objective: cause to improve the user experience (UX) and ease using the product
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants