f - fill docs

Author: alecchendev

lightning/src/chain/channelmonitor.rs

@@ -1454,10 +1454,16 @@ impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
 		self.inner.lock().unwrap().counterparty_commitment_txs_from_update(update)
 	}
 
-	/// Wrapper around [`crate::sign::EcdsaChannelSigner::sign_justice_revoked_output`] to make
+	/// Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
 	/// signing the justice transaction easier for implementors of
 	/// [`chain::chainmonitor::Persist`]. On success this method returns a fully signed
 	/// transaction that is ready to be broadcasted.
+	///
+	/// This method will only succeed if this monitor has received the revocation secret for the
+	/// provided commitment number.
+	///
+	/// [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::EcdsaChannelSigner::sign_justice_revoked_output
+	/// [`Persist`]: crate::chain::chainmonitor::Persist
 	pub fn sign_justice_tx(&self, justice_tx: Transaction, input_idx: usize, value: u64, commitment_number: u64) -> Result<Transaction, ()> {
 		self.inner.lock().unwrap().sign_justice_tx(justice_tx, input_idx, value, commitment_number)
 	}