feat: add high-level workflow documentation for OffersMessageFlow #4400
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 I see @valentinewallace was un-assigned. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4400 +/- ##
==========================================
+ Coverage 86.02% 86.03% +0.01%
==========================================
Files 156 156
Lines 103100 103100
Branches 103100 103100
==========================================
+ Hits 88693 88706 +13
+ Misses 11896 11883 -13
Partials 2511 2511
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:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds high-level, struct-level documentation to
OffersMessageFlowto clarify how it is intended to be used for sending and receiving BOLT 12 payments without aChannelManager. The updated docs expand the existing brief comment into clear, scannable workflow sections covering receiving payments via Offers and Refunds, sending payments via Offers and Refunds, and retrieving pending messages for onion delivery.Closes: #3826