Skip to content

Bindings doc updates for 0.2 - #4203

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged

Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
TheBlueMatt:2025-11-0.2-doc-tweaks

Conversation

@TheBlueMatt

@TheBlueMattTheBlueMatt commented Nov 3, 2025

Copy link
Copy Markdown
Collaborator

No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.

@TheBlueMattTheBlueMatt added this to the 0.2 milestone Nov 3, 2025
@ldk-reviews-bot

ldk-reviews-bot commented Nov 3, 2025•
edited
Loading

Copy link
Copy Markdown

I've assigned @joostjager as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed the 2025-11-0.2-doc-tweaks branch from 32fce5f to 60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed the 2025-11-0.2-doc-tweaks branch from 60a7713 to 4bc993cCompareNovember 3, 2025 21:32
@codecov

codecovBot commented Nov 3, 2025•
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️

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.

joostjager
joostjager reviewed Nov 4, 2025
View reviewed changes

@joostjagerjoostjager left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding

Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.

@joostjagerjoostjagerNov 4, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.

@TheBlueMattTheBlueMattNov 4, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.

@joostjagerjoostjagerNov 4, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.

Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].

@joostjagerjoostjagerNov 4, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?

@TheBlueMattTheBlueMattNov 4, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.

@joostjagerjoostjagerNov 4, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.

@ldk-reviews-bot

ldk-reviews-bot commented Nov 4, 2025

Copy link
Copy Markdown

👋 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.

@TheBlueMatt

TheBlueMatt commented Nov 4, 2025

Copy link
Copy Markdown
CollaboratorAuthor

This is all doc changes so I'm gonna go ahead and land this.

@TheBlueMatt
TheBlueMatt merged commit 2d6e017 into lightningdevkit:mainNov 4, 2025
22 of 25 checks passed
@TheBlueMattTheBlueMatt mentioned this pull request Nov 12, 2025
Merged
@TheBlueMatt

TheBlueMatt commented Nov 12, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Backported in #4221

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Bindings doc updates for 0.2 by TheBlueMatt · Pull Request #4203 · lightningdevkit/rust-lightning · GitHub
Skip to content
Bindings doc updates for 0.2 - #4203
Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Nov 4, 2025
Merged
Bindings doc updates for 0.2#4203
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom 
TheBlueMatt:2025-11-0.2-doc-tweaks
Conversation
@TheBlueMatt
@TheBlueMattTheBlueMatt
commented
Nov 3, 2025

Copy link


Copy Markdown

Collaborator
No-export tags and copy the docs from async to sync traits and structs so that bindings users actually have real docs.
@TheBlueMattTheBlueMatt
added this to the 0.2 milestone
Nov 3, 2025
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

I've assigned @joostjager as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@TheBlueMatt
Mark CheckedHrpstringError instances as no-export
16aabce
The details of these errors aren't particularly relevant, and its
not worth the effort of exporting them, so we just mark them
no-export here.
@TheBlueMatt
Mark BOLT 12 builders no-export in the new OffersMessageFlow
7fb0f2a
As move semantics do not map to bindings, the BOLT 12 object
builders are marked no-export. In the new `OffersMesageFlow`, here,
we also mark the methods which return these builders as no-export.
@TheBlueMatt
Require the high-level sign traits instead of SignFn in bindings
2bf737c
Methods like `StaticInvoice::sign` have their own signing-function
traits, so there's no actual need to use `SignFn` directly, its
just a useful generic wrapper. Sadly, because it uses `AsRef`
bounds, which aren't really practical to map in bindings, we can't
really expose it directly in bindings. Because there's an
alternative and its tricky to expose, we simply mark it no-export
here.
@TheBlueMatt
Mark async traits and structs no-export
3f82fd6
We do not currently support async traits or methods in our
home-grown bindings logic, so here mark them no-export.
@TheBlueMatt
Import ChannelTransactionParameters from its real path
b07111e
Rather than importing `ChannelTransactionParameters` via the `use`
in `lightning::sign`, import it via its real path in
`lightning::sign::ecdsa`. This makes reading the code (incredibly
marginally) simpler, but also makes the bindings generator happy.
@TheBlueMatt
Copy no-export tags to new serialization traits
8eabcc1
In 0.2 we added new `LengthLimitedRead` and `LengthReadable`
traits, but forgot to copy the no-export tags from the existing
`Read` and `Readable` traits. Here we add the missing tags.
@TheBlueMatt
useVec from alloc rather than the crate prelude
126ac50
This avoids confusing the bindings generator.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
32fce5f to
60a7713CompareNovember 3, 2025 21:23
@TheBlueMatt
Copy async docs from async bump transaction objects to sync ones
c311447
When we added the async traits and wrapper structs for the
transaction-bumping logic, we didn't bother copying the
documentation to the sync wrappers as we figured the links
sufficed. Sadly, however, this means that our bindings logic will
have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
We also fix one bogus link in `Wallet`'s docs.
@TheBlueMatt
Provide the same docs in ChangeDestinationSource as the sync one
b55eec7
@TheBlueMatt
Copy async docs from async KVStore to sync one
9516400
When we added the async trait for `KVStore`, we didn't bother
copying the documentation to the sync wrappers as we figured the
links sufficed. Sadly, however, this means that our bindings logic
will have no docs but a broken link to an async object that doesn't
exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
Copy docs from OutputSweeper to OutputSweeperSync
4bc993c
When we added the async wrapper for `OutputSweeper`, we didn't
bother copying the documentation to the sync wrappers as we figured
the links sufficed. Sadly, however, this means that our bindings
logic will have no docs but a broken link to an async object that
doesn't exist.
Instead, here, we copy the docs from the async objects to the sync
ones, at least leaving behind a comment noting that both need
updating whenever one gets updated.
@TheBlueMatt
TheBlueMattforce-pushed
the
2025-11-0.2-doc-tweaks
branch
from
60a7713 to
4bc993cCompareNovember 3, 2025 21:32
@codecov
codecovBot
commented
Nov 3, 2025•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 89.28%. Comparing base (5f8c54a) to head (4bc993c).
⚠️ Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@## main #4203 +/- ##
==========================================
+ Coverage 88.86% 89.28% +0.41% 
==========================================
Files 180 180 Lines 137913 137913 Branches 137913 137913 ==========================================
+ Hits 122560 123130 +570 + Misses 12540 12172 -368 + Partials 2813 2611 -202 
FlagCoverage Δ
fuzzing32.67% <ø> (+11.24%)⬆️
tests88.69% <ø> (-0.03%)⬇️
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.
joostjager
joostjager
reviewed
Nov 4, 2025
View reviewed changes
@joostjagerjoostjager
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly basic questions for my own understanding
Comment threadlightning-invoice/src/lib.rs
Comment threadlightning/src/offers/flow.rs
Comment threadlightning/src/offers/merkle.rs
Comment threadlightning/src/chain/chainmonitor.rs
Comment threadlightning/src/util/async_poll.rs
#[cfg(not(feature = "std"))]
/// Marker trait to optionally implement `Sync` under std.
///
/// This is not exported to bindings users as async is only supported in Rust.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: some of the Maybe* markers were needed for rust 1.63. With the MSRV bump, perhaps some clean up is possible.
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, yea, would be good to go back and remove what we can now.
@joostjagerjoostjagerNov 4, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MIssing the hypothetical rust 'unnecessary bound' warning.
Comment threadlightning/src/util/ser.rs
Comment threadlightning/src/events/bump_transaction/sync.rs

/// A synchronous version of the [`WalletSource`] trait.
/// An alternative to [`CoinSelectionSourceSync`] that can be implemented and used along
/// [`WalletSync`] to provide a default implementation to [`CoinSelectionSourceSync`].
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be an option to link in the reverse direction to not duplicate?
@TheBlueMattTheBlueMattNov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do that, but previously we wanted to avoid that because it it felt like it implied that sync was the "main" way of doing things in Rust, and that async was just a special mode, which isn't what we wanted. I don't feel super strongly, but it did seem simple enough to just copy.
@joostjagerjoostjagerNov 4, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the intention indeed. Hopefully the duplication comment is sufficient.
@ldk-reviews-bot
ldk-reviews-bot
commented
Nov 4, 2025

Copy link


Copy Markdown

👋 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.
@TheBlueMatt
TheBlueMatt
commented
Nov 4, 2025

Copy link


Copy Markdown

CollaboratorAuthor
This is all doc changes so I'm gonna go ahead and land this.
@TheBlueMatt
TheBlueMatt
merged commit 2d6e017
into
lightningdevkit:mainNov 4, 2025

22 of 25 checks passed

@TheBlueMattTheBlueMatt
mentioned this pull request
Nov 12, 2025
 Merged

@TheBlueMatt
TheBlueMatt
commented
Nov 12, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Backported in #4221
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@joostjagerjoostjagerjoostjager approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone

0.2

Development

Successfully merging this pull request may close these issues.

3 participants

@TheBlueMatt@ldk-reviews-bot@joostjager