Allow for user-specified error message during force close channel #2889

Sharmalm · 2024-02-11T13:42:49Z

This Pr solves issue #2840

coderabbitai · 2024-02-11T13:42:56Z

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

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

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-tests 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 tests 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 tests.
- @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.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

TheBlueMatt

Thanks!

lightning/src/ln/channelmanager.rs

codecov-commenter · 2024-02-15T09:59:03Z

Codecov Report

Attention: Patch coverage is 98.24561% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 90.21%. Comparing base (ac9a2c8) to head (d17e759).
Report is 41 commits behind head on main.

Files	Patch %	Lines
lightning/src/ln/channelmanager.rs	94.44%	2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2889      +/-   ##
==========================================
+ Coverage   89.42%   90.21%   +0.78%     
==========================================
  Files         117      118       +1     
  Lines       96290   104723    +8433     
  Branches    96290   104723    +8433     
==========================================
+ Hits        86109    94475    +8366     
- Misses       7962     8097     +135     
+ Partials     2219     2151      -68

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

Sharmalm · 2024-02-18T09:52:31Z

I have updated the PR, Please review. :)

TheBlueMatt

Feel free to squash the fixup commits as you go. Please write a much more detailed commit message describing what was changed and why.

lightning/src/ln/channelmanager.rs

fuzz/src/full_stack.rs

Sharmalm · 2024-02-23T06:41:32Z

I have updated the above changes in my Pr.

Sharmalm · 2024-02-28T09:08:01Z

Gentle reminder for the review.

lightning/src/ln/channelmanager.rs

Sharmalm · 2024-03-04T10:43:01Z

If every thing looks good, I will squash it.

lightning/src/ln/channelmanager.rs

TheBlueMatt

Please proofread your commit before you push, don't rely on reviewers.

lightning/src/ln/channelmanager.rs

Sharmalm · 2024-03-12T06:25:31Z

Please proofread your commit before you push, don't rely on reviewers.

Understood, I'll keep in mind in future.

Sharmalm · 2024-03-12T08:16:01Z

I have Proofread my commits, and i think it is fulfilling the objectives of issue, if not I'll update the PR accordingly :)

TheBlueMatt · 2024-03-12T14:57:10Z

Basically LGTM! Please squash the commit history so that each commit stands on its own and compiles+passes tests and no later commits are fixing/cleaning up things from previous commits (in this PR I think that probably means just one commit). Also please line-wrap the commit message(s) to 70 chars. Finally, note that your diff has some end-of-line whitespace in a few places. A local git show should highlight them for you so you can remove them.

Sharmalm · 2024-03-15T13:04:01Z

Ok,
Thankyou @TheBlueMatt for the guidance to complete this PR.

TheBlueMatt · 2024-03-18T19:50:52Z

Please line-wrap your commit message text.

Sharmalm · 2024-04-02T11:59:29Z

Please line-wrap your commit message text.

Is it fine now?

TheBlueMatt · 2024-04-09T00:44:44Z

No? The lines are still longer than 70 chars?

Sharmalm · 2024-04-09T05:31:56Z

Done.

TheBlueMatt · 2024-04-12T18:55:56Z

CI thinks there's still places that need updating to the new API (possibly needs rebase), other than that this LGTM.

Sharmalm · 2024-04-17T08:58:10Z

CI is also done.
Thanks :)

TheBlueMatt · 2024-04-19T21:58:37Z

CI is still failing, see the check_commits and fuzz jobs.

Sharmalm · 2024-04-20T04:46:44Z

Sorry about that, I missed it.

In this commit i added additional parameter `error_message` to `force_close_sending_error`. This parameter will allow users to configure error message and send to peers during the force closing of channel.I have also updated the tests for this updated function.

TheBlueMatt · 2024-04-22T17:23:41Z

LGTM, but will need to wait for the next release.

TheBlueMatt

Test changes could be cleaned up, but its fine enough.

TheBlueMatt · 2024-06-03T14:44:58Z

lightning/src/ln/payment_tests.rs

@@ -3592,6 +3593,7 @@ fn do_claim_from_closed_chan(fail_payment: bool) {
 	// height.
 	connect_blocks(&nodes[3], final_cltv - HTLC_FAIL_BACK_BUFFER - nodes[3].best_block_info().1
 		- if fail_payment { 0 } else { 2 });
+	let error_message = "Channel force-closed";


It would be nice to keep the variable creation close to the place they're used.

TheBlueMatt · 2024-06-03T14:45:22Z

lightning/src/ln/payment_tests.rs

@@ -3601,7 +3603,7 @@ fn do_claim_from_closed_chan(fail_payment: bool) {
 		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[3], [reason]);
 		pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
 	} else {
-		nodes[1].node.force_close_broadcasting_latest_txn(&chan_bd, &nodes[3].node.get_our_node_id()).unwrap();
+		nodes[1].node.force_close_broadcasting_latest_txn(&chan_bd, &nodes[3].node.get_our_node_id(), error_message.to_string()).unwrap();


It woudl be nice to move the .to_string() to the error_message declaration, reducing the amount of text on the force_close lines.

I guess alternatively, the force_close method could be made to accept &str, or both &str and String?

It could, but inside it needs a String anyway, so we really want that to be the API. Otherwise, eg, the user might do &format!(..), resulting in an allocation of a string, then a reference to it passed to LDK, which then unnecessarily clones.

Sharmalm mentioned this pull request Feb 12, 2024

Allow for user-specified error message to force_close_with*_broadcasting_txn #2840

Closed

TheBlueMatt reviewed Feb 14, 2024

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

Sharmalm force-pushed the 2840 branch from fd549a2 to 19e6767 Compare February 15, 2024 10:28

TheBlueMatt reviewed Feb 20, 2024

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

fuzz/src/full_stack.rs Outdated Show resolved Hide resolved

Sharmalm force-pushed the 2840 branch from 97680c1 to d9f72e2 Compare February 23, 2024 06:25

wpaulino mentioned this pull request Feb 23, 2024

Add HTLCsTimedOut closing reason #2887

Merged

TheBlueMatt reviewed Feb 28, 2024

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Show resolved Hide resolved

TheBlueMatt reviewed Mar 5, 2024

View reviewed changes

lightning/src/ln/channelmanager.rs Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

TheBlueMatt reviewed Mar 7, 2024

View reviewed changes

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

lightning/src/ln/channelmanager.rs Outdated Show resolved Hide resolved

Sharmalm force-pushed the 2840 branch from 634b91c to f989fb9 Compare March 12, 2024 08:04

Sharmalm force-pushed the 2840 branch from f989fb9 to afe939f Compare March 15, 2024 13:01

Sharmalm force-pushed the 2840 branch from afe939f to 555a818 Compare March 21, 2024 09:10

Sharmalm marked this pull request as ready for review March 21, 2024 09:11

Sharmalm force-pushed the 2840 branch from 555a818 to 8f57a04 Compare April 9, 2024 05:30

Sharmalm force-pushed the 2840 branch from 2b8d4fe to 8f57a04 Compare April 17, 2024 05:34

Sharmalm force-pushed the 2840 branch 2 times, most recently from d20bb25 to fd1f2dc Compare April 17, 2024 06:59

Sharmalm force-pushed the 2840 branch from fd1f2dc to 98a63f8 Compare April 20, 2024 04:46

Sharmalm force-pushed the 2840 branch from 98a63f8 to c0e9bd4 Compare April 20, 2024 05:19

Sharmalm force-pushed the 2840 branch from 925d737 to d17e759 Compare April 20, 2024 13:43

TheBlueMatt added the Seeking Code Review label Apr 22, 2024

TheBlueMatt approved these changes Jun 3, 2024

View reviewed changes

TheBlueMatt mentioned this pull request Jun 3, 2024

Don't disconnect on manual force closes #3088

Merged

arik-so approved these changes Jun 3, 2024

View reviewed changes

arik-so merged commit 993cd1e into lightningdevkit:main Jun 3, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow for user-specified error message during force close channel #2889

Allow for user-specified error message during force close channel #2889

Sharmalm commented Feb 11, 2024

coderabbitai bot commented Feb 11, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

TheBlueMatt left a comment

codecov-commenter commented Feb 15, 2024 •

edited

Loading

Sharmalm commented Feb 18, 2024

TheBlueMatt left a comment

Sharmalm commented Feb 23, 2024

Sharmalm commented Feb 28, 2024

Sharmalm commented Mar 4, 2024

TheBlueMatt left a comment

Sharmalm commented Mar 12, 2024

Sharmalm commented Mar 12, 2024

TheBlueMatt commented Mar 12, 2024

Sharmalm commented Mar 15, 2024

TheBlueMatt commented Mar 18, 2024

Sharmalm commented Apr 2, 2024

TheBlueMatt commented Apr 9, 2024

Sharmalm commented Apr 9, 2024

TheBlueMatt commented Apr 12, 2024

Sharmalm commented Apr 17, 2024

TheBlueMatt commented Apr 19, 2024

Sharmalm commented Apr 20, 2024

TheBlueMatt commented Apr 22, 2024

TheBlueMatt left a comment

TheBlueMatt Jun 3, 2024

TheBlueMatt Jun 3, 2024

arik-so Jun 3, 2024

TheBlueMatt Jun 3, 2024

Allow for user-specified error message during force close channel #2889

Allow for user-specified error message during force close channel #2889

Conversation

Sharmalm commented Feb 11, 2024

coderabbitai bot commented Feb 11, 2024 • edited Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

TheBlueMatt left a comment

Choose a reason for hiding this comment

codecov-commenter commented Feb 15, 2024 • edited Loading

Codecov Report

Sharmalm commented Feb 18, 2024

TheBlueMatt left a comment

Choose a reason for hiding this comment

Sharmalm commented Feb 23, 2024

Sharmalm commented Feb 28, 2024

Sharmalm commented Mar 4, 2024

TheBlueMatt left a comment

Choose a reason for hiding this comment

Sharmalm commented Mar 12, 2024

Sharmalm commented Mar 12, 2024

TheBlueMatt commented Mar 12, 2024

Sharmalm commented Mar 15, 2024

TheBlueMatt commented Mar 18, 2024

Sharmalm commented Apr 2, 2024

TheBlueMatt commented Apr 9, 2024

Sharmalm commented Apr 9, 2024

TheBlueMatt commented Apr 12, 2024

Sharmalm commented Apr 17, 2024

TheBlueMatt commented Apr 19, 2024

Sharmalm commented Apr 20, 2024

TheBlueMatt commented Apr 22, 2024

TheBlueMatt left a comment

Choose a reason for hiding this comment

TheBlueMatt Jun 3, 2024

Choose a reason for hiding this comment

TheBlueMatt Jun 3, 2024

Choose a reason for hiding this comment

arik-so Jun 3, 2024

Choose a reason for hiding this comment

TheBlueMatt Jun 3, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Feb 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov-commenter commented Feb 15, 2024 •

edited

Loading