-
Notifications
You must be signed in to change notification settings - Fork 436
ChannelManager read refactor follow ups #4374
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
base: main
Are you sure you want to change the base?
Conversation
Reorder the struct fields to place all three `_legacy` fields together at the end, allowing the explanatory comment to appear once instead of being duplicated three times. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Initialize pending_claiming_payments and monitor_update_blocked_actions_per_peer with None and resolve with unwrap_or_else, matching the pattern used for other optional hash map fields like pending_intercepted_htlcs_legacy. Co-Authored-By: Claude Opus 4.5 <[email protected]>
|
👋 Thanks for assigning @valentinewallace as a reviewer! |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4374 +/- ##
==========================================
+ Coverage 85.99% 86.02% +0.02%
==========================================
Files 156 156
Lines 102766 102844 +78
Branches 102766 102844 +78
==========================================
+ Hits 88378 88471 +93
+ Misses 11879 11863 -16
- Partials 2509 2510 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
valentinewallace
left a comment
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.
Care to throw in any of these mentioned updates? #4332 (comment) Seems like a good opportunity
lightning/src/ln/channelmanager.rs
Outdated
| testing_dnssec_proof_offer_resolution_override: Mutex::new(new_hash_map()), | ||
| }; | ||
|
|
||
| // Step 7: Replay pending claims and fail HTLCs. |
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.
In my experience using step numbers in ldk-sample main, it's kinda annoying to have to update all of them when something changes. Maybe that's not as much of a risk here
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.
I thought it might help a bit with navigation in this huge function. In other languages one would quickly extract methods, but in my experience that isn't always in Rust. Would you prefer that? I can try it.
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.
I wouldn't really prefer extracting methods. Just wanted to point it out, we can keep the numbers
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.
Made it unnumbered headings
|
👋 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. |
Add step comments to from_channel_manager_data to clarify the seven logical phases of ChannelManager reconstruction: 1. Channel/monitor reconciliation 2. Initialize missing optional fields 3. Replay in-flight monitor updates 4. Reconstruct HTLC state from monitors 5. Reconstruct claimable payments 6. Construct the ChannelManager 7. Replay pending claims and fail HTLCs Co-Authored-By: Claude Opus 4.5 <[email protected]>
Since there is no semantic difference between None and Some(empty vec) for peer_storage_dir, simplify the type to Vec and use unwrap_or_default() when reading from TLV fields. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Instead of keeping claimable_htlc_onion_fields as a separate field in ChannelManagerData and zipping it in stage 2, perform the zip in stage 1 so that claimable_htlcs_list already contains the onion fields. This simplifies stage 2 by removing the nested if-else for onion fields handling. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Since there is no semantic difference between None and Some(empty map) for in_flight_monitor_updates, simplify the type to HashMap and use unwrap_or_default() when reading from TLV fields. Co-Authored-By: Claude Opus 4.5 <[email protected]>
13a8a3f to
b4429bb
Compare
Done |
valentinewallace
left a comment
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 cleanups here!
| // consistency. Channels that are behind their monitors are force-closed. Channels without | ||
| // monitors (except those awaiting initial persistence) are rejected. Monitors without |
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.
I don't think it's true that channels without monitors will be rejected -- instead, we'll DecodeError::InvalidValue on the entire manager read. Were these comments added by Claude? I'm kinda not sold on them, they add to the review quite a bit and seem error prone/at risk of becoming out-of-date
| async_receive_offer_cache: AsyncReceiveOfferCache, | ||
| // Marked `_legacy` because in versions > 0.2 we are taking steps to remove the requirement of | ||
| // regularly persisting the `ChannelManager` and instead rebuild the set of HTLC forwards from | ||
| // `Channel{Monitor}` data. See [`ChannelManager::read`]. |
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.
I don't think ChannelManager::read adds anything to the understanding of what's going on here, can probably remove that sentence
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.
Yes, this was pointing to the reconstruct boolean, but can't link that.
| .into_iter() | ||
| .zip(onion_fields) | ||
| .map(|((hash, htlcs), onion)| (hash, htlcs, onion)) | ||
| .collect() |
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.
Hmm, we introduce an intermediate allocation here. Wonder if the whole creation of claimable_payments can move here, to avoid it? It feels somewhat fitting.
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.
I've considered that, but it would need the keys for the legacy handling branch. But perhaps that's ok? The distinction between stage 1 and 2 isn't carved in stone.
| .unwrap_or_else(new_hash_map), | ||
| inbound_payment_id_secret, | ||
| in_flight_monitor_updates, | ||
| in_flight_monitor_updates: in_flight_monitor_updates.unwrap_or_default(), |
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.
Will this use HashMap::new() or new_hash_map (which I think is what we want)? CI seems fine though...
Followup commits to improve the readability and maintainability of the
ChannelManagerdeserialization code.