Skip to content

Commit 4cb4d66

Browse files
committed
Address doc nits
We address some minor mistakes that made it into the docs before.
1 parent dcc531e commit 4cb4d66

File tree

5 files changed

+18
-10
lines changed

5 files changed

+18
-10
lines changed

lightning-liquidity/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Currently the following specifications are supported:
66
- [LSPS0] defines the transport protocol with the LSP over which the other protocols communicate.
77
- [LSPS1] allows to order Lightning channels from an LSP. This is useful when the client needs
88
inbound Lightning liquidity for which they are willing and able to pay in bitcoin.
9-
- [LSPS2] allows to generate a special invoice for which, when paid, an LSP will open a "just-in-time".
10-
This is useful for the initial on-boarding of clients as the channel opening fees are deducted
11-
from the incoming payment, i.e., no funds are required client-side to initiate this flow.
9+
- [LSPS2] allows to generate a special invoice for which, when paid, an LSP
10+
will open a "just-in-time" channel. This is useful for the initial
11+
on-boarding of clients as the channel opening fees are deducted from the
12+
incoming payment, i.e., no funds are required client-side to initiate this
13+
flow.
1214

1315
To get started, you'll want to setup a `LiquidityManager` and configure it to be the `CustomMessageHandler` of your LDK node. You can then call `LiquidityManager::lsps1_client_handler` / `LiquidityManager::lsps2_client_handler`, or `LiquidityManager::lsps2_service_handler`, to access the respective client-side or service-side handlers.
1416

lightning-liquidity/src/lib.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@
1414
//! - [LSPS0] defines the transport protocol with the LSP over which the other protocols communicate.
1515
//! - [LSPS1] allows to order Lightning channels from an LSP. This is useful when the client needs
1616
//! inbound Lightning liquidity for which they are willing and able to pay in bitcoin.
17-
//! - [LSPS2] allows to generate a special invoice for which, when paid, an LSP will open a "just-in-time".
18-
//! This is useful for the initial on-boarding of clients as the channel opening fees are deducted
19-
//! from the incoming payment, i.e., no funds are required client-side to initiate this flow.
17+
//! - [LSPS2] allows to generate a special invoice for which, when paid, an LSP will open a
18+
//! "just-in-time" channel. This is useful for the initial on-boarding of clients as the channel
19+
//! opening fees are deducted from the incoming payment, i.e., no funds are required client-side to
20+
//! initiate this flow.
2021
//!
2122
//! To get started, you'll want to setup a [`LiquidityManager`] and configure it to be the
2223
//! [`CustomMessageHandler`] of your LDK node. You can then for example call

lightning-liquidity/src/lsps0/client.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Contains the main LSPS2 client-side object, [`LSPS0ClientHandler`].
1+
//! Contains the main LSPS0 client-side object, [`LSPS0ClientHandler`].
22
//!
33
//! Please refer to the [LSPS0
44
//! specifcation](https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS0) for more

lightning-liquidity/src/lsps0/msgs.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Message, request, and other primitive types used to implement LSPS1.
1+
//! Message, request, and other primitive types used to implement LSPS0.
22
33
use crate::lsps0::ser::{LSPSMessage, RequestId, ResponseError};
44
use crate::prelude::Vec;

lightning-liquidity/src/manager.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,18 @@ pub struct LiquidityClientConfig {
7575
/// Users need to continually poll [`LiquidityManager::get_and_clear_pending_events`] in order to surface
7676
/// [`Event`]'s that likely need to be handled.
7777
///
78-
/// If configured, users must forward the [`Event::HTLCIntercepted`] event parameters to [`LSPS2ServiceHandler::htlc_intercepted`]
79-
/// and the [`Event::ChannelReady`] event parameters to [`LSPS2ServiceHandler::channel_ready`].
78+
/// If the LSPS2 service is configured, users must forward the following parameters from LDK events:
79+
/// - [`Event::HTLCIntercepted`] to [`LSPS2ServiceHandler::htlc_intercepted`]
80+
/// - [`Event::ChannelReady`] to [`LSPS2ServiceHandler::channel_ready`]
81+
/// - [`Event::HTLCHandlingFailed`] to [`LSPS2ServiceHandler::htlc_handling_failed`]
82+
/// - [`Event::PaymentForwarded`] to [`LSPS2ServiceHandler::payment_forwarded`]
8083
///
8184
/// [`PeerManager`]: lightning::ln::peer_handler::PeerManager
8285
/// [`MessageHandler`]: lightning::ln::peer_handler::MessageHandler
8386
/// [`Event::HTLCIntercepted`]: lightning::events::Event::HTLCIntercepted
8487
/// [`Event::ChannelReady`]: lightning::events::Event::ChannelReady
88+
/// [`Event::HTLCHandlingFailed`]: lightning::events::Event::HTLCHandlingFailed
89+
/// [`Event::PaymentForwarded`]: lightning::events::Event::PaymentForwarded
8590
pub struct LiquidityManager<ES: Deref + Clone, CM: Deref + Clone, C: Deref + Clone>
8691
where
8792
ES::Target: EntropySource,

0 commit comments

Comments
 (0)