-
Notifications
You must be signed in to change notification settings - Fork 345
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
Allow specifying an error when failing back HTLC #1948
Allow specifying an error when failing back HTLC #1948
Conversation
Codecov ReportBase: 90.80% // Head: 90.75% // Decreases project coverage by
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #1948 +/- ##
==========================================
- Coverage 90.80% 90.75% -0.05%
==========================================
Files 98 98
Lines 51507 51733 +226
Branches 51507 51733 +226
==========================================
+ Hits 46770 46952 +182
- Misses 4737 4781 +44
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could anyone explain (or point me to a resource that explains) what the failure codes in HTLCFailReason::Reason are?
Here are the possible failure codes/messages: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages
Re: testing, the expect_payment_failed
macro in functional_test_utils
checks a failed payment's error code and data :)
Thanks so much for the feedback @valentinewallace! I'll try to address most of the suggestions in about an hour or so. |
Looking pretty good to me. You'll want to amend your commit history at some point, we follow bitcoin core's guidelines: https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits |
Feel free to request a review once you've added tests or otherwise want another look |
Will rebase tomorrow, but besides that I've mostly gotten through a new implementation that I think makes more sense as well as some tests. I only implemented the four failure codes @TheBlueMatt mentioned ( In Also had some miscellaneous questions:
|
5da7871
to
ae453eb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! This looks pretty great to me. Instead of merging in upstream changes, please rebase per the guide at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#rebasing-changes (and squash down fixup commits into one linear history that has logically separate commits that don't fix previous commits in the same PR).
Sadly, no. Rust has some ability to just recompile files that have changed, but its been on and off depending on the rust version due to various bugs. We also are (very slowly) working on breaking up our functional tests into more files to make this less painful. Speaking of which, please consider moving your new test to |
Oh I see, thanks.
Just to clarify, should I be squashing any time I make changes in the PR or just at the end? |
It depends on the reviewer, in general we usually coordinate with reviewers by asking if they're ready for squashing, though that can delay PRs some so if its a relatively minor change feel free to just squash as you go - there's no hard rule here, we're flexible. |
8b943c4
to
21bbd2d
Compare
cb1b3ea
to
3935324
Compare
Btw I moved the code to fetch the corresponding error data to create the |
9ddf1e6
to
037226a
Compare
LGTM, I think. Please squash the fixup commit at the end back down into the second commit so we don't have commits fixing previous commits in the same PR. |
31de6db
to
9f50950
Compare
9f50950
to
55254e8
Compare
6e9eb5b
to
5ae1547
Compare
Okay, I think the commits should be all fixed up 👍 |
5ae1547
to
6e485ae
Compare
Just squashed the first two commits together because the added function from the second commit was referenced in the first commit's documentation. Now it should be good I think. |
FailureCode is used to specify which error code and data to send to peers when failing back an HTLC. ChannelManager::fail_htlc_backwards_with_reason allows a user to specify the error code and corresponding data to send to peers when failing back an HTLC. This function is mentioned in Event::PaymentClaimable docs. ChannelManager::get_htlc_fail_reason_from_failure_code was also added to assist with this function.
Add a test for newly added function failing back a basic payment and ensuring the intended failure code and data are sent back to the peer.
6e485ae
to
48aef2d
Compare
Fixes #1570. This PR adds a new
FailureCode
enum, and a new functionChannelManager::fail_htlc_backwards_with_reason
to allow the user to input their own failure reason (FailureCode
) to form anHTLCFailReason
to send to peers when failing back in response to anEvent::PaymentClaimable
. It also addsdo_test_fail_htlc_backwards_with_reason
and the testtest_fail_htlc_backwards_with_reason
.Notes
fail_htlc_backwards
andfail_htlc_backwards_with_reason
but because the msat + height data is found individually for each HTLC to form the error (infail_htlc_backwards
), not sure how I would.To do
fail_htlc_backwards
, however I couldn't really find wherefail_htlc_backwards
was explicitly tested, mainly just used/indirectly tested throughoutln/functional_tests.rs
. Still figuring what the best way to test this is.Questions
This is my first PR on this repo so please forgive me if I'm asking something trivial! I'm going to try and participate in more code review to get more assimilated to the repo, but in the meantime if anyone is able to provide any feedback I'd greatly appreciate it.