Introduce bLIP numbers in lightning-liquidity documentation
#3510
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheBlueMatt
reviewed
Jan 15, 2025
|
Feel free to squash. |
tnull
force-pushed
the
2025-01-start-referring-to-liquidity-blips
branch
from
0fd3c19 to
4f077b9
Compare
Done diff --git a/lightning-liquidity/src/lsps2/client.rs b/lightning-liquidity/src/lsps2/client.rs
index 70881de6f..9f56f98a2 100644
--- a/lightning-liquidity/src/lsps2/client.rs
+++ b/lightning-liquidity/src/lsps2/client.rs
@@ -62,5 +62,5 @@ impl PeerState {
/// Note that currently only the 'client-trusts-LSP' trust model is supported, i.e., we don't
/// provide any additional API guidance to allow withholding the preimage until the channel is
-/// opened. Please refer to the [`LSPS2 / blIP-52 specification`] for more information.
+/// opened. Please refer to the [`LSPS2 / bLIP-52 specification`] for more information.
///
/// [`LSPS2 / bLIP-52 specification`]: https://github.com/lightning/blips/blob/master/blip-0052.md#trust-models |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3510 +/- ##
==========================================
+ Coverage 88.30% 90.46% +2.16%
==========================================
Files 149 149
Lines 112921 130229 +17308
Branches 112921 130229 +17308
==========================================
+ Hits 99718 117816 +18098
+ Misses 10722 10071 -651
+ Partials 2481 2342 -139 ☔ View full report in Codecov by Sentry. |
tnull
force-pushed
the
2025-01-start-referring-to-liquidity-blips
branch
from
4f077b9 to
761fbb0
Compare
|
Addressed the comment, and also globally switched |
tnull
force-pushed
the
2025-01-start-referring-to-liquidity-blips
branch
from
761fbb0 to
92424be
Compare
Recently, LSPS0, 1, and 2 were upstreamed as bLIP-50, 51, and 52, respectively. Here, we 1. start linking to the bLIPs instead of the LSP spec repository, which is likely going to be deprecated. 2. start consistently citing the specs as `bLIP-5X / LSPSX` to avoid any confusions and to potentially initiate a process in which the LSP specs will be referred to by their bLIP number rather than their LSPS number (especially given that any upcoming specs by the LSP spec group will directly be drafted as bLIPs going forward).
tnull
force-pushed
the
2025-01-start-referring-to-liquidity-blips
branch
from
92424be to
09a79c2
Compare
TheBlueMatt
approved these changes
Feb 4, 2025
|
Just doc changes, so gonna land. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently, LSPS0, 1, and 2 were upstreamed as bLIP-50, 51, and 52, respectively.
Here, we
bLIP-5X / LSPSXto avoid any confusions and to potentially initiate a process in which the LSP specs will over time get referred to by their bLIP number rather than their LSPS number (especially given that any upcoming specs by the LSP spec group will directly be drafted as bLIPs going forward).