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

Trigger packet processing manually through an endpoint #3398

Closed
5 tasks
Tracked by #3437
nik-suri opened this issue Jun 5, 2023 · 2 comments · Fixed by #3401
Closed
5 tasks
Tracked by #3437

Trigger packet processing manually through an endpoint #3398

nik-suri opened this issue Jun 5, 2023 · 2 comments · Fixed by #3401
Assignees
Labels
O: new-feature Objective: cause to add a new feature or support
Milestone

Comments

@nik-suri
Copy link

nik-suri commented Jun 5, 2023

Summary

Enable users to manually specify packets to be clear on demand by {channel-id}/{sequence_number}.

Problem Definition

There is a command hermes clear packets, but the intention behind this command seems to be that it should be run while the relayer process is not running. It would be helpful to manually instruct the running relayer process to clear packets on demand. While I believe that hermes is eventually consistent, clearing packets on demand can be helpful in situations when one needs to urgently test a flow, or users are complaining about long wait times - it seems that sometimes packets sit around for a while before being relayed.

Proposal

I imagine the most straightforward way to implement this could be through an http endpoint. We could have 3 endpoints:

  1. /clear-packets - to clear all packets from all IBC channels being monitored
  2. /clear-packets/{channel-id} - to clear all packets from a given IBC channel
  3. /clear-packets/{channel-id}/{sequence_number} - to clear a single specific packet.

Acceptance Criteria

Functionality is implemented, whether through an http endpoint or not, that allows the relayer operator to clear packets manually on demand.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@romac
Copy link
Member

romac commented Jun 6, 2023

Can you give this branch a try and see if it works for you? #3401

@seanchen1991 seanchen1991 moved this from 🩹 Triage to 📥 Todo in Hermes Jun 6, 2023
@seanchen1991 seanchen1991 added this to the v1.7 milestone Jun 6, 2023
@seanchen1991 seanchen1991 moved this from 📥 Todo to 🏗 In progress in Hermes Jun 6, 2023
@seanchen1991 seanchen1991 modified the milestones: v1.7, v1.6 Jun 6, 2023
@seanchen1991 seanchen1991 added the O: new-feature Objective: cause to add a new feature or support label Jun 6, 2023
@romac
Copy link
Member

romac commented Jun 14, 2023

@nik-suri Can you please give this branch a try and see if it works for you? #3401

@seanchen1991 seanchen1991 moved this from 🏗 In progress to 🔖 Needs review in Hermes Jun 20, 2023
@romac romac modified the milestones: v1.6, v1.7 Jul 18, 2023
@github-project-automation github-project-automation bot moved this from 🔖 Needs review to ✅ Done in Hermes Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
O: new-feature Objective: cause to add a new feature or support
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

3 participants