Skip to content

fix: delete already refunded fees from state if some fee cannot be refunded on channel closure (backport #6255) #6270

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 10, 2024
Merged

fix: delete already refunded fees from state if some fee cannot be refunded on channel closure (backport #6255) #6270

merged 3 commits into from
May 10, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 7, 2024

Description

While refunding fees for a packet on channel closure, some fees could be refunded and some not. Those fees that are refunded should be deleted from state, so that there is no possibility of them being refunded again if the packet fee information for a packet is used somehow.

closes: #XXXX

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Refactor
    • Updated logic in RefundFeesOnChannelClosure function to handle unrefunded fees by storing them in a new slice and updating packet fees accordingly.
  • Bug Fixes
    • Fixed a bug where refunded fees were not deleted from the state if some fees could not be refunded during channel closure.
This is an automatic backport of pull request #6255 done by [Mergify](https://mergify.com).

@crodriguezvega @mergify
fix: delete already refunded fees from state if some fee cannot be re…
19f1eba 
…funded on channel closure (#6255)

* delete the refunded fees in case an error happens in the loop that refunds fees on channel closure

* test simplifications

* fix typo

* clean up code

* fix logic

* add changelog

(cherry picked from commit 500765e)

# Conflicts:
#	modules/apps/29-fee/keeper/escrow_test.go
@mergify mergify bot added the conflicts label May 7, 2024
@mergify Mergify
Copy link
Contributor Author

mergify bot commented May 7, 2024

Cherry-pick of 500765e has failed:

On branch mergify/bp/release/v8.3.x/pr-6255
Your branch is up to date with 'origin/release/v8.3.x'.

You are currently cherry-picking commit 500765e4.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   CHANGELOG.md
	modified:   modules/apps/29-fee/keeper/escrow.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   modules/apps/29-fee/keeper/escrow_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 7, 2024

Important

Auto Review Skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@crodriguezvega crodriguezvega merged commit 0cece8d into release/v8.3.x May 10, 2024
@crodriguezvega crodriguezvega deleted the mergify/bp/release/v8.3.x/pr-6255 branch May 10, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AdityaSripal AdityaSripal Awaiting requested review from AdityaSripal

@charleenfei charleenfei Awaiting requested review from charleenfei

@colin-axner colin-axner Awaiting requested review from colin-axner

@damiannolan damiannolan Awaiting requested review from damiannolan

@chatton chatton Awaiting requested review from chatton

@DimitrisJim DimitrisJim Awaiting requested review from DimitrisJim

1 more reviewer

@crodriguezvega crodriguezvega crodriguezvega approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@crodriguezvega