Skip to content

Commit 39a2655

Browse files
committed
f - improve sign_justice_tx docs
1 parent 233b3c2 commit 39a2655

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1457,11 +1457,16 @@ impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
14571457

14581458
/// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
14591459
/// signing the justice transaction easier for implementors of
1460-
/// [`chain::chainmonitor::Persist`]. On success this method returns a fully signed
1461-
/// transaction that is ready to be broadcasted.
1460+
/// [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
1461+
/// signing the input at `input_idx`.
1462+
///
1463+
/// `Value` is the value of the output being spent by the input at `input_idx`, committed
1464+
/// in the BIP 143 signature.
14621465
///
14631466
/// This method will only succeed if this monitor has received the revocation secret for the
1464-
/// provided commitment number.
1467+
/// provided `commitment_number`. If a commitment number is provided that does not correspond
1468+
/// to the commitment transaction being revoked, this will return a signed transaction, but
1469+
/// the signature will not be valid.
14651470
///
14661471
/// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
14671472
/// [`Persist`]: crate::chain::chainmonitor::Persist

0 commit comments

Comments
 (0)