Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add draft 0.1 release notes #3530

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

TheBlueMatt
Copy link
Collaborator

We'll have to add a few more things as backports land, but this should be basically it.

@TheBlueMatt TheBlueMatt added this to the 0.1 milestone Jan 14, 2025
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@dunxen
Copy link
Contributor

dunxen commented Jan 14, 2025

Might have missed it while trying to grep, but should

not be there?

Also I think some of the pending_changelogs existed before the 0.1 branch off. Are some of them still from 0.0.125 but haven't been deleted?

@TheBlueMatt
Copy link
Collaborator Author

Errr, duh, sorry, forgot to go through that list fully.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.48%. Comparing base (f92c4dc) to head (89b0d34).
Report is 26 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3530      +/-   ##
==========================================
+ Coverage   88.36%   89.48%   +1.12%     
==========================================
  Files         149      149              
  Lines      112875   118824    +5949     
  Branches   112875   118824    +5949     
==========================================
+ Hits        99742   106330    +6588     
+ Misses      10653    10129     -524     
+ Partials     2480     2365     -115     

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

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
* The `max_level_*` features were removed as the performance gain compared to
doing the limiting at runtime was negligible (#3431).
* `ChannelManager::create_bolt11_invoice` was added, deprecating the
`lightning::ln::invoice_utils` module (#3389).
Copy link
Contributor

Choose a reason for hiding this comment

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

Noted elsewhere that the module is still used for phantom invoice utils. Perhaps we just rename it next release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We should probably make create_bolt11_invoice support phantom invoices instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

IIUC, the utilities work without a ChannelManager as you would be accumulating PhantomRouteHints from multiple sources.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Mmm, right. We should at least rename the module, then :)

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
startup (#3305).

## Node Compatibility
* LDK now handles fields in the experimental range of BOLT 12 messages (#3237).
Copy link
Contributor

Choose a reason for hiding this comment

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

consider: s/fields/TLVs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fields feels more generally understandable vs the (kinda-)lightning-specific terminology?

Comment on lines +20 to +23
* `ChannelMonitor`s no longer need to be re-persisted after deserializing the
`ChannelManager` before beginning normal operation. As such,
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like the note in backwards compatibility should be referenced here. IIUC, persistence is required at least once? And maybe the following sentence should come first to emphasize the API change here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The second is pretty minor (the user's code will fail to compile, if it even matters at all), but I referenced the backwards compat section explicitly.

@TheBlueMatt TheBlueMatt mentioned this pull request Jan 14, 2025
Copy link
Contributor

@jkczyz jkczyz left a comment

Choose a reason for hiding this comment

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

LGTM. Good to squash, IMO.

@TheBlueMatt
Copy link
Collaborator Author

Squashed.

@TheBlueMatt
Copy link
Collaborator Author

Note that I cancelled CI so other PRs can run, it doesn't really matter here, anyway, CI doesn't look at our release notes at all.

@jkczyz
Copy link
Contributor

jkczyz commented Jan 15, 2025

Looks like we need to account for the notes added in #3531.

@TheBlueMatt
Copy link
Collaborator Author

I was assuming that wouldn't make 0.1, I don't think we need to block 0.1 on it - its not a regression and it should only happen with a buggy Router.

@TheBlueMatt TheBlueMatt merged commit 3fbf97d into lightningdevkit:main Jan 15, 2025
16 of 25 checks passed
@TheBlueMatt
Copy link
Collaborator Author

Backported in #3536.

tnull pushed a commit to tnull/rust-lightning that referenced this pull request Jan 16, 2025
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.

4 participants