Skip to content

Commit c8bb1d9

Browse files
committed
Document LSPS2 BOLT12 router flow
Clarify that InvoiceParametersReady supports BOLT11 route hints and BOLT12 offer flows via LSPS2BOLT12Router registration. Co-Authored-By: HAL 9000
1 parent f90a77b commit c8bb1d9

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

lightning-liquidity/src/lsps2/event.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,17 @@ pub enum LSPS2ClientEvent {
4949
/// When the invoice is paid, the LSP will open a channel with the previously agreed upon
5050
/// parameters to you.
5151
///
52+
/// For BOLT11 JIT invoices, `intercept_scid` and `cltv_expiry_delta` can be used in a route
53+
/// hint.
54+
///
55+
/// For BOLT12 JIT flows, register these parameters for your offer id on an
56+
/// [`LSPS2BOLT12Router`] and then proceed with the regular BOLT12 offer
57+
/// flow. The router will inject the LSPS2-specific blinded payment path when creating the
58+
/// invoice.
59+
///
5260
/// **Note: ** This event will *not* be persisted across restarts.
61+
///
62+
/// [`LSPS2BOLT12Router`]: crate::lsps2::router::LSPS2BOLT12Router
5363
InvoiceParametersReady {
5464
/// The identifier of the issued bLIP-52 / LSPS2 `buy` request, as returned by
5565
/// [`LSPS2ClientHandler::select_opening_params`].

0 commit comments

Comments
 (0)