Skip to content

Commit 9330e98

Browse files
committed
f Add some more doces on _handler API methods
1 parent 6d50a8a commit 9330e98

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

lightning-liquidity/src/manager.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,9 @@ where {
226226
}
227227

228228
/// Returns a reference to the LSPS1 client-side handler.
229+
///
230+
/// The returned hendler allows to initiate the LSPS1 client-side flow, i.e., allows to request
231+
/// channels from the configured LSP.
229232
pub fn lsps1_client_handler(&self) -> Option<&LSPS1ClientHandler<ES>> {
230233
self.lsps1_client_handler.as_ref()
231234
}
@@ -237,11 +240,17 @@ where {
237240
}
238241

239242
/// Returns a reference to the LSPS2 client-side handler.
243+
///
244+
/// The returned hendler allows to initiate the LSPS2 client-side flow. That is, it allows to
245+
/// retrieve all necessary data to create 'just-in-time' invoices that, when paid, will have
246+
/// the configured LSP open a 'just-in-time' channel.
240247
pub fn lsps2_client_handler(&self) -> Option<&LSPS2ClientHandler<ES>> {
241248
self.lsps2_client_handler.as_ref()
242249
}
243250

244251
/// Returns a reference to the LSPS2 server-side handler.
252+
///
253+
/// The returned hendler allows to initiate the LSPS2 service-side flow.
245254
pub fn lsps2_service_handler(&self) -> Option<&LSPS2ServiceHandler<CM>> {
246255
self.lsps2_service_handler.as_ref()
247256
}

0 commit comments

Comments
 (0)