lightning: improve accept_forwards_to_priv_channels doc
#3786
Conversation
|
I've assigned @valentinewallace as a reviewer! |
lightning/src/util/config.rs
Outdated
| @@ -830,6 +830,8 @@ pub struct UserConfig { | |||
| /// all your channels and open new ones. For privacy, you should also change your node_id | |||
| /// (swapping all private and public key material for new ones) at that time. | |||
| /// | |||
| /// Note that this setting does not apply for intercepted payments, we manually forward them. | |||
There was a problem hiding this comment.
Maybe say that the payments are surfaced via [Event::HTLCIntercepted] (with a doc link) and manually forwarded.
There was a problem hiding this comment.
Thank you. I'll update it.
There was a problem hiding this comment.
@valentinewallace is this better "Note that this setting does not apply for intercepted payments that are surfaced via [Event::HTLCIntercepted] and manually forwarded."?
There was a problem hiding this comment.
Looks good, thanks!
|
👋 The first review has been submitted! Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer. |
Anyitechs
force-pushed
the
doc-accept-forwards-to-priv-channels
branch
from
be83fa3 to
25a9564
Compare
| @@ -830,6 +830,9 @@ pub struct UserConfig { | |||
| /// all your channels and open new ones. For privacy, you should also change your node_id | |||
| /// (swapping all private and public key material for new ones) at that time. | |||
| /// | |||
| /// Note that this setting does not apply for intercepted payments that are surfaced via | |||
| /// [`Event::HTLCIntercepted`] and manually forwarded. | |||
There was a problem hiding this comment.
I believe you need to add an import line for this, similar to the one on accept_underpaying_htlcs
There was a problem hiding this comment.
I've fixed that. Thank you.
Anyitechs
force-pushed
the
doc-accept-forwards-to-priv-channels
branch
from
25a9564 to
bd07a92
Compare
|
Can you squash and limit the commit message title to 50 characters? |
Document that `accept_forwards_to_priv_channels` does not apply for intercepted payments.
Anyitechs
force-pushed
the
doc-accept-forwards-to-priv-channels
branch
from
bd07a92 to
2e5ff7e
Compare
Anyitechs
changed the title
accept_forwards_to_priv_channels does not apply for intercepted paymentsaccept_forwards_to_priv_channels doc
This PR documents that
accept_forwards_to_priv_channelsdoes not apply for intercepted payments, that we manually forward them.Closes #3679