-
Notifications
You must be signed in to change notification settings - Fork 411
Improve ChannelDetails readability significantly. #988
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
Improve ChannelDetails readability significantly. #988
Conversation
Codecov Report
@@ Coverage Diff @@
## main #988 +/- ##
==========================================
- Coverage 90.73% 90.72% -0.02%
==========================================
Files 60 60
Lines 30702 30656 -46
==========================================
- Hits 27857 27812 -45
+ Misses 2845 2844 -1
Continue to review 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.
Thanks for making this change!
After the merge of lightningdevkit#984, Jeff pointed out that `ChannelDetails` has become a bit of a "bag of variables", and that a few of the variable names in lightningdevkit#984 were more confusing than necessary in context. This addresses several issues by: * Splitting counterparty parameters into a separate `ChannelCounterpartyParameters` struct, * using the name `unspendable_punishment_reserve` for both outbound and inbound channel reserves, differentiating them based on their position in the counterparty parameters struct or not, * Using the name `force_close_spend_delay` instead of `spend_csv_on_our_commitment_funds` to better communicate what is occurring.
ceca6f4
to
2b08a47
Compare
Squashed with no changes, only changes since Jeff's ACK are below. Will merge after CI.
|
After the merge of #984, Jeff pointed out that
ChannelDetails
hasbecome a bit of a "bag of variables", and that a few of the variable
names in #984 were more confusing than necessary in context.
This addresses several issues by:
ChannelCounterpartyParameters
struct,unspendable_punishment_reserve
for both outboundand inbound channel reserves, differentiating them based on their
position in the counterparty parameters struct or not,
force_close_spend_delay
instead ofspend_csv_on_our_commitment_funds
to better communicate whatis occurring.