f - fill docs

Author: alecchendev

lightning/src/chain/channelmonitor.rs

@@ -1437,7 +1437,8 @@ impl<Signer: WriteableEcdsaChannelSigner> ChannelMonitor<Signer> {
 	/// justice transactions for any revoked commitment transactions. It's intended to be used
 	/// within an implementation of [`Persist::update_persisted_channel`], which is provided with
 	/// a monitor and an update. Note that this simply provides the counterparty commitment
-	/// transactions from an update, which may or may not have been revoked yet.
+	/// transactions from an update, which may or may not have been revoked yet. Once revoked,
+	/// signing a justice transaction can be done using [`Self::sign_justice_tx`].
 	///
 	/// It is expected that a watchtower may use this method to retrieve the latest counterparty
 	/// commitment transaction(s), and then hold the necessary data until a later update in which
@@ -1453,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)
 	}