Skip to content

Commit f3da21e

Browse files
committed
Mention user_channel_id uniqueness in invoice_params_generated docs
We update the docs of `invoice_params_generated` and mention that `user_channel_id` needs to be unique value.
1 parent 3b6a3c8 commit f3da21e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

lightning-liquidity/src/lsps2/service.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -749,12 +749,16 @@ where
749749
}
750750
}
751751

752-
/// Used by LSP to provide the client with the intercept scid and
753-
/// `cltv_expiry_delta` to include in their invoice. The intercept scid
754-
/// must be retrieved from [`ChannelManager::get_intercept_scid`].
752+
/// Used by LSP to provide the client with the intercept scid, a unique `user_channel_id`, and `cltv_expiry_delta` to
753+
/// include in their invoice.
754+
///
755+
/// The intercept scid must be retrieved from [`ChannelManager::get_intercept_scid`]. The given
756+
/// `user_channel_id` must be locally unique and will eventually be returned via events to be
757+
/// used when opening the channel via [`ChannelManager::create_channel`].
755758
///
756759
/// Should be called in response to receiving a [`LSPS2ServiceEvent::BuyRequest`] event.
757760
///
761+
/// [`ChannelManager::create_channel`]: lightning::ln::channelmanager::ChannelManager::create_channel
758762
/// [`ChannelManager::get_intercept_scid`]: lightning::ln::channelmanager::ChannelManager::get_intercept_scid
759763
/// [`LSPS2ServiceEvent::BuyRequest`]: crate::lsps2::event::LSPS2ServiceEvent::BuyRequest
760764
#[allow(clippy::await_holding_lock)]

0 commit comments

Comments
 (0)