Skip to content

feat: add high-level workflow documentation for OffersMessageFlow - #4400

Open
okekefrancis112 wants to merge 1 commit into
lightningdevkit:mainfrom
okekefrancis112:high_level_docs
Open

okekefrancis112 wants to merge 1 commit into
lightningdevkit:mainfrom
okekefrancis112:high_level_docs

Conversation

@okekefrancis112

Copy link
Copy Markdown
Contributor

This PR adds high-level, struct-level documentation to OffersMessageFlow to clarify how it is intended to be used for sending and receiving BOLT 12 payments without a ChannelManager. 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

@ldk-reviews-bot

ldk-reviews-bot commented Feb 8, 2026 •

Copy link
Copy Markdown

👋 I see @valentinewallace was un-assigned.
If you'd like another reviewer assignment, please click here.

@codecov

codecov Bot commented Feb 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.03%. Comparing base (2e4a2ac) to head (8641a4e).

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              
Flag Coverage Δ
tests 86.03% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@TheBlueMatt
TheBlueMatt removed the request for review from valentinewallace February 9, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OffersFlow needs high-level docs

2 participants