Skip to content

Commit d7e465c

Browse files
committed
Tweak our_to_self_delay documentation wording to make it flow better
1 parent 90de1c4 commit d7e465c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

lightning/src/util/config.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,20 @@ pub struct ChannelHandshakeConfig {
2323
///
2424
/// Default value: 6.
2525
pub minimum_depth: u32,
26-
/// Set to the amount of time we require our counterparty to wait to claim their money.
26+
/// Set to the number of blocks we require our counterparty to wait to claim their money (ie
27+
/// the number of blocks we have to punish our counterparty if they broadcast a revoked
28+
/// transaction).
2729
///
28-
/// It's one of the main parameter of our security model. We (or one of our watchtowers) MUST
29-
/// be online to check for peer having broadcast a revoked transaction to steal our funds
30-
/// at least once every our_to_self_delay blocks.
30+
/// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
31+
/// be online to check for revoked transactions on-chain at least once every our_to_self_delay
32+
/// blocks (plus some margin to allow us enough time to broadcast and confirm a transaction).
3133
///
3234
/// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
3335
/// case of an honest unilateral channel close, which implicitly decrease the economic value of
3436
/// our channel.
3537
///
36-
/// Default value: [`BREAKDOWN_TIMEOUT`] (currently 144), we enforce it as a minimum at channel
37-
/// opening so you can tweak config to ask for more security, not less.
38+
/// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
39+
/// can tweak config to ask for more security, not less.
3840
pub our_to_self_delay: u16,
3941
/// Set to the smallest value HTLC we will accept to process.
4042
///

0 commit comments

Comments
 (0)