lsp_plugin: add documentation for options
What the developer wrote
Authored by Peter Neuroth
lsp_plugin: add documentation for options
Signed-off-by: Peter Neuroth <pet.v.ne@gmail.com>
What changed, and why it matters
This commit only adds user-facing documentation describing three already-existing experimental configuration options for a Lightning Service Provider (LSP) plugin. There are no code changes, no behavior changes, and no security fixes.
No security action required; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff updates doc/lightningd-config.5.md to document the options experimental-lsps-client, experimental-lsps2-service, and experimental-lsps2-promise-secret. It also fixes a trailing whitespace issue on an unrelated Tor line and adds a [blip] link reference. No implementation code is modified.
Changed components
doc/lightningd-config.5.mdInspect captured patch +20 / −1
diff --git a/doc/lightningd-config.5.md b/doc/lightningd-config.5.md
index 41011e16..a905d29e 100644
--- a/doc/lightningd-config.5.md
+++ b/doc/lightningd-config.5.md
@@ -598,7 +598,7 @@ the address is announced.
IPv4 or IPv6 address of the Tor control port (default port 9051),
and this will be used to configure a Tor hidden service for port 9735
in case of mainnet (bitcoin) network whereas other networks (testnet,
-testnet4, signet, regtest) will set the same default ports they use for
+testnet4, signet, regtest) will set the same default ports they use for
non-Tor addresses (see above).
The Tor hidden service will be configured to point to the
first IPv4 or IPv6 address we bind to and is by default unique to
@@ -827,6 +827,24 @@ The operations will be bundled into a single transaction. The channel will remai
active while awaiting splice confirmation, however you can only spend the smaller
of the prior channel balance and the new one.
+* **experimental-lsps-client**
+
+ Specifying this enables client side support for the lsps protocol
+([blip][blip] #50). Core-Lightning only supports the lsps2 ([blip][blip] #52)
+subprotocol describing the creation of just-in-time-channel (JIT-channels)
+between a LSP and this client.
+
+* **experimental-lsps2-service**
+
+ Specifying this enables a LSP JIT-Channel service according to the lsps
+protocol ([blip][blip] #52). It requires a LSP-Policy plugin to be available and
+a *experimental-lsps2-promise-secret* to be set.
+
+* **experimental-lsps2-promise-secret**=*promisesecret*
+
+ Sets a `promisesecret` for the LSP JIT-Channel service. Is a 64-character hex
+ string that acts as the secret for promises according to ([blip][blip] #52).
+ Is required if *experimental-lsps2-service* is set.
BUGS
----
@@ -861,3 +879,4 @@ the rest of the code is covered by the BSD-style MIT license.
[bolt]: https://github.com/lightning/bolts
[bolt12]: https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md
[pr4421]: https://github.com/ElementsProject/lightning/pull/4421
+[blip]: https://github.com/lightning/blips
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.