Skip to content

Commit 46b22d0

Browse files
fixup: improve docs
1 parent f2ab40b commit 46b22d0

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

lightning-liquidity/src/lsps2/service.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,7 +1018,7 @@ where
10181018
///
10191019
/// Note that `next_channel_id` and `skimmed_fee_msat` are required to be provided. Therefore, the corresponding
10201020
/// [`Event::PaymentForwarded`] events need to be generated and serialized by LDK versions
1021-
/// greater or equal to 0.0.107.
1021+
/// greater or equal to 0.0.122.
10221022
///
10231023
/// [`Event::PaymentForwarded`]: lightning::events::Event::PaymentForwarded
10241024
pub fn payment_forwarded(
@@ -1552,7 +1552,8 @@ where
15521552
}
15531553

15541554
/// Checks if the JIT channel with the given `user_channel_id` needs manual broadcast.
1555-
/// Will be true if client_trusts_lsp is set to true
1555+
///
1556+
/// Will be `true` if `client_trusts_lsp` is set to `true`.
15561557
pub fn channel_needs_manual_broadcast(
15571558
&self, user_channel_id: u128, counterparty_node_id: &PublicKey,
15581559
) -> Result<bool, APIError> {
@@ -1584,8 +1585,9 @@ where
15841585
Ok(jit_channel.is_client_trusts_lsp())
15851586
}
15861587

1587-
/// Called to store the funding transaction for a JIT channel.
1588-
/// This should be called when the funding transaction is created but before it's broadcast.
1588+
/// Stores the funding transaction for a JIT channel.
1589+
///
1590+
/// Call this when the funding transaction is created.
15891591
pub fn store_funding_transaction(
15901592
&self, user_channel_id: u128, counterparty_node_id: &PublicKey, funding_tx: Transaction,
15911593
) -> Result<(), APIError> {

lightning-liquidity/tests/lsps2_integration_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -948,7 +948,7 @@ fn client_trusts_lsp_end_to_end_test() {
948948
// 9. The client will see the PaymentClaimable event
949949
// 10. Assert that the service has not broadcasted the funding transaction yet, because the client has not claimed the HTLC yet
950950
// 11. Make the client claim the HTLC
951-
// 12. Assert that the service has now received the BroadcastTransaction event, and we broadcast it
951+
// 12. Assert that the service has broadcasted the funding tx
952952
// 13. Assert that the payer received the PaymentSent event
953953
let chanmon_cfgs = create_chanmon_cfgs(3);
954954
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);

0 commit comments

Comments
 (0)