fix(opbot): use submitter get tx status [SLT-158]

[golangisfun123]

Description
A clear and concise description of the features you're adding in this pull request.

Additional context
Add any other context about the problem you're solving.

Metadata

• Fixes #[Link to Issue]

Summary by CodeRabbit

• New Features

  • Improved transaction status checking for refunds, enhancing user experience.

• Bug Fixes

  • Enhanced error handling ensures clearer communication of transaction issues to users.

[coderabbitai]

Walkthrough

The changes involve modifications to the rfqRefund function in the contrib/opbot/botmd/commands.go file. The function's logic for fetching transaction information has been updated to use GetSubmissionStatus instead of GetTxHashByNonce. This change enhances error handling by checking the transaction's existence before proceeding and adjusting the user response accordingly.

Changes

Files	Change Summary
contrib/opbot/botmd/commands.go	Updated rfqRefund function to use GetSubmissionStatus for transaction status. Added error handling for transaction existence. Introduced a new variable var status submitter.SubmissionStatus.

Poem

In the garden of code, a change took flight,
With logic refined, oh what a delight!
Transactions now dance, with status in hand,
Errors are caught, like grains of sand.
Hooray for the tweaks, let the bunnies cheer,
For smoother flows and no more fear! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 37.95337%. Comparing base (d4d1c5a) to head (5744995).

Files with missing lines	Patch %	Lines
contrib/opbot/botmd/commands.go	0.00000%	4 Missing ⚠️

Additional details and impacted files

@@                 Coverage Diff                 @@
##              master       #3134         +/-   ##
===================================================
+ Coverage   36.37752%   37.95337%   +1.57585%     
===================================================
  Files            438         418         -20     
  Lines          25535       24235       -1300     
  Branches          82          82                 
===================================================
- Hits            9289        9198         -91     
+ Misses         15505       14298       -1207     
+ Partials         741         739          -2     

Flag	Coverage Δ
opbot	0.48870% <0.00000%> (+0.00149%)	⬆️
promexporter	?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cloudflare-workers-and-pages]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	5744995
Status:	✅  Deploy successful!
Preview URL:	https://75c0ca5f.sanguine-fe.pages.dev
Branch Preview URL:	https://use-submitter.sanguine-fe.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

contrib/opbot/botmd/commands.go (1)

Inconsistent usage of GetSubmissionStatus and GetTxHashByNonce methods

While the change to GetSubmissionStatus in the reviewed file is correct, there are still several instances of GetTxHashByNonce being used in other parts of the codebase. This inconsistency could lead to potential issues and maintenance difficulties.

• Review and update the following files to use GetSubmissionStatus:

  • services/rfq/relayer/relapi/client_test.go
  • services/rfq/relayer/relapi/handler.go
  • services/rfq/relayer/relapi/client.go
  • services/rfq/relayer/cmd/commands.go

• After updating, assess if GetTxHashByNonce can be safely removed or if it serves a distinct purpose that needs to be maintained.

Analysis chain

Line range hint 344-349: Verify the usage of the GetSubmissionStatus method.

The change from using GetTxHashByNonce to GetSubmissionStatus seems to be a good improvement. However, please ensure that this change is consistently applied across the codebase and that it behaves as expected.

Run the following script to verify the usage of GetSubmissionStatus:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the `GetSubmissionStatus` method.

# Test 1: Search for the usage of `GetTxHashByNonce`. Expect: No occurrences.
rg --type go $'GetTxHashByNonce'

# Test 2: Search for the usage of `GetSubmissionStatus`. Expect: Occurrences in relevant code paths.
rg --type go $'GetSubmissionStatus' -A 5

Length of output: 3356

---

Script:

#!/bin/bash
# Description: Further verify the usage of GetTxHashByNonce and GetSubmissionStatus

# Test 1: Search for remaining uses of GetTxHashByNonce that might need updating
rg --type go 'GetTxHashByNonce\(' -C 3

# Test 2: Look for interfaces or structs that still define GetTxHashByNonce
ast-grep --lang go --pattern 'interface {
  $$$
  GetTxHashByNonce($_) $_
  $$$
}'

# Test 3: Verify consistency of GetSubmissionStatus usage
rg --type go 'GetSubmissionStatus\(' -C 3

Length of output: 6045

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 377a7fa and 57af32d.

Files selected for processing (1)

• contrib/opbot/botmd/commands.go (3 hunks)

Additional comments not posted (1)

contrib/opbot/botmd/commands.go (1)

340-340: LGTM!

The addition of the status variable is a good way to store the submission status.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

contrib/opbot/botmd/commands.go (1)

Line range hint 351-372: Offer to add tests for uncovered lines.

The static analysis hints indicate that the added lines are not covered by tests. Adding tests for these lines will help ensure the correctness and reliability of the code.

Do you want me to generate the test code or open a GitHub issue to track this task?

Tools

GitHub Check: codecov/patch

[warning] 351-351: contrib/opbot/botmd/commands.go#L351
Added line #L351 was not covered by tests

---

[warning] 355-356: contrib/opbot/botmd/commands.go#L355-L356
Added lines #L355 - L356 were not covered by tests

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 57af32d and 5744995.

Files selected for processing (1)

• contrib/opbot/botmd/commands.go (3 hunks)

Additional context used

GitHub Check: codecov/patch

contrib/opbot/botmd/commands.go

[warning] 351-351: contrib/opbot/botmd/commands.go#L351
Added line #L351 was not covered by tests

---

[warning] 355-356: contrib/opbot/botmd/commands.go#L355-L356
Added lines #L355 - L356 were not covered by tests

---

[warning] 372-372: contrib/opbot/botmd/commands.go#L372
Added line #L372 was not covered by tests

Additional comments not posted (3)

contrib/opbot/botmd/commands.go (3)

28-28: LGTM!

The import statement for the submitter package is added correctly.

---

Line range hint 351-372: Verify the changes and add tests.

The code changes look good and enhance the functionality by using the submitter package to fetch the submission status. The error handling and updated response are appropriate.

However, please ensure that the added lines are covered by tests to maintain code quality and prevent potential bugs.

Tools

GitHub Check: codecov/patch

[warning] 351-351: contrib/opbot/botmd/commands.go#L351
Added line #L351 was not covered by tests

---

[warning] 355-356: contrib/opbot/botmd/commands.go#L355-L356
Added lines #L355 - L356 were not covered by tests

---

28-28: Duplicate code segment.

This code segment has already been reviewed and approved in a previous comment.